mirror of
https://github.com/woocommerce/woocommerce-rest-api-docs.git
synced 2026-07-27 08:35:25 +08:00
8881 lines
775 KiB
HTML
8881 lines
775 KiB
HTML
|
|
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
<title>WooCommerce REST API Documentation v2</title>
|
|
|
|
<link rel="icon" href="images/favicon-32x32-83e66af5.png" sizes="32x32" />
|
|
<link rel="icon" href="images/favicon-192x192-1360b554.png" sizes="192x192" />
|
|
<link rel="apple-touch-icon-precomposed" href="images/favicon-180x180-11109413.png" />
|
|
<meta name="msapplication-TileImage" content="images/favicon-270x270-16b8f5e2.png" />
|
|
|
|
<style>
|
|
.highlight table td { padding: 5px; }
|
|
.highlight table pre { margin: 0; }
|
|
.highlight .gh {
|
|
color: #999999;
|
|
}
|
|
.highlight .sr {
|
|
color: #f6aa11;
|
|
}
|
|
.highlight .go {
|
|
color: #888888;
|
|
}
|
|
.highlight .gp {
|
|
color: #555555;
|
|
}
|
|
.highlight .gs {
|
|
}
|
|
.highlight .gu {
|
|
color: #aaaaaa;
|
|
}
|
|
.highlight .nb {
|
|
color: #f6aa11;
|
|
}
|
|
.highlight .cm {
|
|
color: #75715e;
|
|
}
|
|
.highlight .cp {
|
|
color: #75715e;
|
|
}
|
|
.highlight .c1 {
|
|
color: #75715e;
|
|
}
|
|
.highlight .cs {
|
|
color: #75715e;
|
|
}
|
|
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
|
|
color: #75715e;
|
|
}
|
|
.highlight .err {
|
|
color: #960050;
|
|
}
|
|
.highlight .gr {
|
|
color: #960050;
|
|
}
|
|
.highlight .gt {
|
|
color: #960050;
|
|
}
|
|
.highlight .gd {
|
|
color: #49483e;
|
|
}
|
|
.highlight .gi {
|
|
color: #49483e;
|
|
}
|
|
.highlight .ge {
|
|
color: #49483e;
|
|
}
|
|
.highlight .kc {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .kd {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .kr {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .no {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .kt {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .mf {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .mh {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .il {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .mi {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .mo {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .m, .highlight .mb, .highlight .mx {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .sc {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .se {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .ss {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .sd {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .s2 {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .sb {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .sh {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .si {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .sx {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .s1 {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .s, .highlight .sa, .highlight .dl {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .na {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .nc {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .nd {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .ne {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .nf, .highlight .fm {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .vc {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .nn {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .nl {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .ni {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .bp {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .vg {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .vi {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .nv, .highlight .vm {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .w {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .n, .highlight .py, .highlight .nx {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .ow {
|
|
color: #f92672;
|
|
}
|
|
.highlight .nt {
|
|
color: #f92672;
|
|
}
|
|
.highlight .k, .highlight .kv {
|
|
color: #f92672;
|
|
}
|
|
.highlight .kn {
|
|
color: #f92672;
|
|
}
|
|
.highlight .kp {
|
|
color: #f92672;
|
|
}
|
|
.highlight .o {
|
|
color: #f92672;
|
|
}
|
|
</style>
|
|
<link href="stylesheets/screen-0b45e388.css" rel="stylesheet" media="screen" />
|
|
<link href="stylesheets/print-c427a123.css" rel="stylesheet" media="print" />
|
|
<script src="javascripts/all_nosearch-c275c2f6.js"></script>
|
|
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-8KCYZ2CYMS"></script>
|
|
<script>
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag('js', new Date());
|
|
|
|
gtag('config', 'G-8KCYZ2CYMS', {
|
|
'content_group' : 'WooCommerce REST API Docs',
|
|
});
|
|
</script>
|
|
</head>
|
|
|
|
<body class="v2 has-warning" data-languages="["shell","javascript","python","php","ruby"]">
|
|
<a href="#" id="nav-button">
|
|
<span>
|
|
NAV
|
|
<img src="images/navbar-cad8cdcb.png" alt="" />
|
|
</span>
|
|
</a>
|
|
<div class="toc-wrapper">
|
|
<a href="#" class="logo">
|
|
<img src="images/logo-9d2c3aad.png" alt="" />
|
|
</a>
|
|
<div class="lang-selector">
|
|
<a href="#" data-language-name="shell">cURL</a>
|
|
<a href="#" data-language-name="javascript">Node.js</a>
|
|
<a href="#" data-language-name="python">Python</a>
|
|
<a href="#" data-language-name="php">PHP</a>
|
|
<a href="#" data-language-name="ruby">Ruby</a>
|
|
</div>
|
|
<ul id="toc" class="toc-list-h1">
|
|
<li>
|
|
<a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#requirements" class="toc-h2 toc-link" data-title="Requirements">Requirements</a>
|
|
</li>
|
|
<li>
|
|
<a href="#version" class="toc-h2 toc-link" data-title="Version">Version</a>
|
|
</li>
|
|
<li>
|
|
<a href="#schema" class="toc-h2 toc-link" data-title="Schema">Schema</a>
|
|
</li>
|
|
<li>
|
|
<a href="#requests-responses" class="toc-h2 toc-link" data-title="Requests/Responses">Requests/Responses</a>
|
|
</li>
|
|
<li>
|
|
<a href="#authentication" class="toc-h2 toc-link" data-title="Authentication">Authentication</a>
|
|
</li>
|
|
<li>
|
|
<a href="#parameters" class="toc-h2 toc-link" data-title="Parameters">Parameters</a>
|
|
</li>
|
|
<li>
|
|
<a href="#pagination" class="toc-h2 toc-link" data-title="Pagination">Pagination</a>
|
|
</li>
|
|
<li>
|
|
<a href="#link-header" class="toc-h2 toc-link" data-title="Link Header">Link Header</a>
|
|
</li>
|
|
<li>
|
|
<a href="#errors" class="toc-h2 toc-link" data-title="Errors">Errors</a>
|
|
</li>
|
|
<li>
|
|
<a href="#http-verbs" class="toc-h2 toc-link" data-title="HTTP Verbs">HTTP Verbs</a>
|
|
</li>
|
|
<li>
|
|
<a href="#jsonp-support" class="toc-h2 toc-link" data-title="JSONP Support">JSONP Support</a>
|
|
</li>
|
|
<li>
|
|
<a href="#webhooks" class="toc-h2 toc-link" data-title="Webhooks">Webhooks</a>
|
|
</li>
|
|
<li>
|
|
<a href="#troubleshooting" class="toc-h2 toc-link" data-title="Troubleshooting">Troubleshooting</a>
|
|
</li>
|
|
<li>
|
|
<a href="#official-libraries" class="toc-h2 toc-link" data-title="Official Libraries">Official Libraries</a>
|
|
</li>
|
|
<li>
|
|
<a href="#tools" class="toc-h2 toc-link" data-title="Tools">Tools</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#index" class="toc-h1 toc-link" data-title="Index">Index</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#index-properties" class="toc-h2 toc-link" data-title="Index Properties">Index Properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-index-list" class="toc-h2 toc-link" data-title="View Index List">View Index List</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#coupons" class="toc-h1 toc-link" data-title="Coupons">Coupons</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#coupon-properties" class="toc-h2 toc-link" data-title="Coupon Properties">Coupon Properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-coupon" class="toc-h2 toc-link" data-title="Create A Coupon">Create A Coupon</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-a-coupon" class="toc-h2 toc-link" data-title="View A Coupon">View A Coupon</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-coupons" class="toc-h2 toc-link" data-title="View List Of Coupons">View List Of Coupons</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-coupon" class="toc-h2 toc-link" data-title="Update A Coupon">Update A Coupon</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-coupon" class="toc-h2 toc-link" data-title="Delete A Coupon">Delete A Coupon</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-coupons-count" class="toc-h2 toc-link" data-title="View Coupons Count">View Coupons Count</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#customers" class="toc-h1 toc-link" data-title="Customers">Customers</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#customers-properties" class="toc-h2 toc-link" data-title="Customers Properties">Customers Properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-customer" class="toc-h2 toc-link" data-title="Create A Customer">Create A Customer</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-a-customer" class="toc-h2 toc-link" data-title="View A Customer">View A Customer</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-customers" class="toc-h2 toc-link" data-title="View List Of Customers">View List Of Customers</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-customer" class="toc-h2 toc-link" data-title="Update A Customer">Update A Customer</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-customer" class="toc-h2 toc-link" data-title="Delete A Customer">Delete A Customer</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-customer-orders" class="toc-h2 toc-link" data-title="View Customer Orders">View Customer Orders</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-customer-downloads" class="toc-h2 toc-link" data-title="View Customer Downloads">View Customer Downloads</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-customers-count" class="toc-h2 toc-link" data-title="View Customers Count">View Customers Count</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#orders" class="toc-h1 toc-link" data-title="Orders">Orders</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#orders-properties" class="toc-h2 toc-link" data-title="Orders Properties">Orders Properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-an-order" class="toc-h2 toc-link" data-title="Create An Order">Create An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-an-order" class="toc-h2 toc-link" data-title="View An Order">View An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-orders" class="toc-h2 toc-link" data-title="View List Of Orders">View List Of Orders</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-an-order" class="toc-h2 toc-link" data-title="Update An Order">Update An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-an-order" class="toc-h2 toc-link" data-title="Delete An Order">Delete An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-orders-count" class="toc-h2 toc-link" data-title="View Orders Count">View Orders Count</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-order-statuses" class="toc-h2 toc-link" data-title="View List Of Order Statuses">View List Of Order Statuses</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-note-for-an-order" class="toc-h2 toc-link" data-title="Create A Note For An Order">Create A Note For An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-an-order-note" class="toc-h2 toc-link" data-title="View An Order Note">View An Order Note</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-notes-from-an-order" class="toc-h2 toc-link" data-title="View List Of Notes From An Order">View List Of Notes From An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-an-order-note" class="toc-h2 toc-link" data-title="Update An Order Note">Update An Order Note</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-an-order-note" class="toc-h2 toc-link" data-title="Delete An Order Note">Delete An Order Note</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-refund-for-an-order" class="toc-h2 toc-link" data-title="Create A Refund For An Order">Create A Refund For An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-an-order-refund" class="toc-h2 toc-link" data-title="View An Order Refund">View An Order Refund</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-refunds-from-an-order" class="toc-h2 toc-link" data-title="View List Of Refunds From An Order">View List Of Refunds From An Order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-an-order-refund" class="toc-h2 toc-link" data-title="Update An Order Refund">Update An Order Refund</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-an-order-refund" class="toc-h2 toc-link" data-title="Delete An Order Refund">Delete An Order Refund</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#products" class="toc-h1 toc-link" data-title="Products">Products</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#products-properties" class="toc-h2 toc-link" data-title="Products Properties">Products Properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-product" class="toc-h2 toc-link" data-title="Create A Product">Create A Product</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-a-product" class="toc-h2 toc-link" data-title="View A Product">View A Product</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-products" class="toc-h2 toc-link" data-title="View List Of Products">View List Of Products</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-product" class="toc-h2 toc-link" data-title="Update A Product">Update A Product</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-product" class="toc-h2 toc-link" data-title="Delete A Product">Delete A Product</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-products-count" class="toc-h2 toc-link" data-title="View Products Count">View Products Count</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-product-reviews" class="toc-h2 toc-link" data-title="View List Of Product Reviews">View List Of Product Reviews</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-a-product-category" class="toc-h2 toc-link" data-title="View A Product Category">View A Product Category</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-product-categories" class="toc-h2 toc-link" data-title="View List Of Product Categories">View List Of Product Categories</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#reports" class="toc-h1 toc-link" data-title="Reports">Reports</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#reports-filters" class="toc-h2 toc-link" data-title="Reports Filters">Reports Filters</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-reports" class="toc-h2 toc-link" data-title="View List Of Reports">View List Of Reports</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-sales-report" class="toc-h2 toc-link" data-title="View List Of Sales Report">View List Of Sales Report</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-top-sellers-report" class="toc-h2 toc-link" data-title="View List Of Top Sellers Report">View List Of Top Sellers Report</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#webhooks" class="toc-h1 toc-link" data-title="Webhooks">Webhooks</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#webhooks-properties" class="toc-h2 toc-link" data-title="Webhooks Properties">Webhooks Properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-webhook" class="toc-h2 toc-link" data-title="Create A Webhook">Create A Webhook</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-a-webhook" class="toc-h2 toc-link" data-title="View A Webhook">View A Webhook</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-webhooks" class="toc-h2 toc-link" data-title="View List Of Webhooks">View List Of Webhooks</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-webhook" class="toc-h2 toc-link" data-title="Update A Webhook">Update A Webhook</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-webhook" class="toc-h2 toc-link" data-title="Delete A Webhook">Delete A Webhook</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-webhooks-count" class="toc-h2 toc-link" data-title="View Webhooks Count">View Webhooks Count</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-a-webhooks-delivery" class="toc-h2 toc-link" data-title="View A Webhooks Delivery">View A Webhooks Delivery</a>
|
|
</li>
|
|
<li>
|
|
<a href="#view-list-of-webhooks-deliveries" class="toc-h2 toc-link" data-title="View List Of Webhooks Deliveries">View List Of Webhooks Deliveries</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="toc-footer">
|
|
<li><a href="https://github.com/woocommerce/woocommerce-rest-api-docs">Contributing to WC REST API Docs</a></li>
|
|
<li><a href="https://github.com/woocommerce/woocommerce/tree/master/includes/rest-api">REST API Source on GitHub</a></li>
|
|
<li><a href="https://github.com/woocommerce/woocommerce/issues?labels=API&page=1&state=open">REST API Issues</a></li>
|
|
<li><a href="https://docs.woocommerce.com/documentation/plugins/woocommerce/">WooCommerce Documentation</a></li>
|
|
<li><a href="https://github.com/woocommerce/woocommerce">WooCommerce Repository</a></li>
|
|
<li><a href="https://github.com/tripit/slate">Documentation Powered by Slate</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="page-wrapper">
|
|
<div class="dark-box"></div>
|
|
<div class="content">
|
|
<h1 id='introduction'>Introduction</h1>
|
|
<p>Introduced in WooCommerce 2.1, the REST API allows store data to be created, read, updated, and deleted using the JSON format.</p>
|
|
<h2 id='requirements'>Requirements</h2>
|
|
<p>You must be using WooCommerce 2.1 or newer and the REST API must be enabled under <code>WooCommerce > Settings</code>. You must enable pretty permalinks, as default permalinks will not work.</p>
|
|
|
|
<aside class="notice">
|
|
Many endpoints were improving with new versions of WooCommerce, so we always recommend keeping your WooCommerce updated to work properly with this documentation.
|
|
</aside>
|
|
<h2 id='version'>Version</h2>
|
|
<p>The current API version is <code>v3</code> which takes a first-order position in endpoints.</p>
|
|
|
|
<p>Check the API versions present in every version of WooCommerce:</p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>API Version</th>
|
|
<th>WooCommerce</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>v1</code></td>
|
|
<td>2.1.x, 2.2.x, 2.3.x and 2.4.x</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>v2</code></td>
|
|
<td>2.2.x, 2.3.x and 2.4.x</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>v3</code></td>
|
|
<td>2.4.x</td>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<p>The <code>v1</code> and <code>v2</code> will be removed in future versions.</p>
|
|
<h3 id='differences-between-v1-and-v2-versions'>Differences between v1 and v2 versions</h3>
|
|
<ul>
|
|
<li>v1 supports XML response format, v2 only supports JSON.</li>
|
|
<li>v1 does not support creating or updating (with the exception of order status) any resources, v2 supports full create/read/update/delete for all endpoints.</li>
|
|
<li>v1 does not include order item meta, v2 includes full order item meta (with an optional <code>filter</code> parameter to include protected order item meta)</li>
|
|
<li>v1 does not include any endpoints for listing a customer's available downloads, v2 includes the <code>GET /customer/{id}/downloads</code> endpoint.</li>
|
|
<li>v1 includes an endpoint for listing notes for an order, v2 includes full create/read/update/delete endpoints.</li>
|
|
<li>v1 does not include any endpoints for listing product categories, v2 includes two endpoints for product categories (<code>GET /products/categories</code> and <code>GET /products/categories/{id}</code>).</li>
|
|
<li>v1 does not include any endpoints for getting valid order statuses, v2 includes an endpoint for listing valid order statuses (<code>GET /orders/statuses</code>).</li>
|
|
<li>v2 supports the core features added in WooCommerce 2.2, primarily order refunds (via the <code>/orders/refunds</code> endpoint) and Webhooks (via the <code>/webhooks</code>).</li>
|
|
</ul>
|
|
<h3 id='differences-between-v3-and-old-versions'>Differences between v3 and old versions</h3>
|
|
<ul>
|
|
<li>v3 implement full basic authentication (<a href="http://tools.ietf.org/html/rfc2617">conforms to the Basic auth spec)</a>).</li>
|
|
<li>v3 fixes the OAuth implementation to be compliant with the <a href="http://tools.ietf.org/html/rfc5849">Oauth 1.0a specs</a>.</li>
|
|
<li>v3 include a new endpoint to get all product orders.</li>
|
|
<li>v3 have new endpoints to allow bulk actions as edition and creation of products, orders, customers and coupons.</li>
|
|
<li>v3 introduce new product attribute endpoints (<code>GET</code>, <code>POST</code>, <code>PUT</code> and <code>DELETE</code>).</li>
|
|
<li>v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character, besides that there is a filter callend <code>filter[sku]</code>).</li>
|
|
<li>v3 include category thumbnails on the requests for <code>product/categories</code>.</li>
|
|
<li>v3 uses our option to auto generate passwords for new customers.</li>
|
|
</ul>
|
|
<h3 id='api-docs-for-each-version'>API Docs for each version</h3>
|
|
<ul>
|
|
<li><a href="v1.html">WooCommerce REST API v1 docs</a></li>
|
|
<li><a href="v2.html">WooCommerce REST API v2 docs</a></li>
|
|
<li><a href="./">WooCommerce REST API v3 docs</a></li>
|
|
</ul>
|
|
<h2 id='schema'>Schema</h2>
|
|
<p>The API is accessible via this endpoint:</p>
|
|
|
|
<p><code>https://www.your-store.com/wc-api/v2</code></p>
|
|
|
|
<p>You may access the API over either HTTP or HTTPS. HTTPS is recommended where possible, as authentication is simpler. The API index will declare if the site supports SSL or not.</p>
|
|
<h2 id='requests-responses'>Requests/Responses</h2>
|
|
<p>The default response format is JSON. Requests with a message-body use plain JSON to set or update resource attributes. Successful requests will return a <code>200 OK</code> HTTP status.</p>
|
|
|
|
<p>Some general information about responses:</p>
|
|
|
|
<ul>
|
|
<li><p>Dates are returned in <a href="http://www.ietf.org/rfc/rfc3339.txt">RFC3339</a> format in UTC timezone: <code>YYYY-MM-DDTHH:MM:SSZ</code></p></li>
|
|
<li><p>Resource IDs are returned as integers.</p></li>
|
|
<li><p>Any decimal monetary amount, such as prices or totals, are returned as strings with two decimal places. The decimal separator (typically either <code>.</code> or <code>,</code>) is controlled by the site and is included in the API index. This is by design, in order to make localization of API data easier for the client. You may need to account for this in your implemetation if you will be doing calculations with the returned data (e.g. convert string amounts with commas as the decimal place before performing any calculations)</p></li>
|
|
<li><p>Other amounts, such as item counts, are returned as integers.</p></li>
|
|
<li><p>Blank fields are generally included as <code>null</code> instead of being blank strings or omitted.</p></li>
|
|
</ul>
|
|
<h2 id='authentication'>Authentication</h2>
|
|
<p>There are two aways to authenticate with the API, depending on whether the site supports SSL or not. Remember that the Index endpoint will indicate if the site supports SSL or not.</p>
|
|
<h3 id='over-https'>Over HTTPS</h3>
|
|
<p>You may use <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">HTTP Basic Auth</a> by providing the API Consumer Key as the username and the API Consumer Secret as the password.</p>
|
|
|
|
<blockquote>
|
|
<p>HTTP Basic Auth example</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://www.example.com/wc-api/v2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div>
|
|
<p>Occasionally some servers may not properly parse the Authorization header (if you see a "Consumer key is missing" error when authenticating over SSL, you have a server issue). In this case, you may provide the consumer key/secret as query string parameters.</p>
|
|
|
|
<blockquote>
|
|
<p>Example for servers that not properly parse the Authorization header:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://www.example.com/wc-api/v2/orders?consumer_key<span class="o">=</span>123&consumer_secret<span class="o">=</span>abc
|
|
</code></pre></div><h3 id='over-http'>Over HTTP</h3>
|
|
<p>You must use <a href="http://tools.ietf.org/html/rfc5849">OAuth 1.0a "one-legged" authentication</a> to ensure API credentials cannot be intercepted. Typically you may use any standard OAuth 1.0a library in your language of choice to handle the authentication, or generate the necessary parameters by following these instructions.</p>
|
|
<h4 id='generating-an-oauth-signature'>Generating an OAuth signature</h4>
|
|
<p>1) Set the HTTP method for the request:</p>
|
|
|
|
<p><code>GET</code></p>
|
|
|
|
<p>2) Set your base request URI -- this is the full request URI without query string parameters -- and URL encode according to RFC 3986:</p>
|
|
|
|
<p><code>http://www.example.com/wc-api/v1/orders</code></p>
|
|
|
|
<p>when encoded:</p>
|
|
|
|
<p><code>http%3A%2F%2Fwww.example.com%2Fwc-api%2Fv1%2Forders</code></p>
|
|
|
|
<p>3) Collect and normalize your query string parameters. This includes all <code>oauth_*</code> parameters except for the signature. Parameters should be normalized by URL encoding according to RFC 3986 (<code>rawurlencode</code> in PHP) and percent(<code>%</code>) characters should be double-encoded (e.g. <code>%</code> becomes <code>%25</code>.</p>
|
|
|
|
<p>4) Sort the parameters in byte-order (<code>uksort( $params, 'strcmp' )</code> in PHP)</p>
|
|
|
|
<p>5) Join each parameter with an encoded equals sign (<code>%3D</code>):</p>
|
|
|
|
<p><code>oauth_signature_method%3DHMAC-SHA1</code></p>
|
|
|
|
<p>6) Join each parameter key/value with an encoded ampersand (<code>%26</code>):</p>
|
|
|
|
<p><code>oauth_consumer_key%3Dabc123%26oauth_signature_method%3DHMAC-SHA1</code></p>
|
|
|
|
<p>7) Form the string to sign by joining the HTTP method, encoded base request URI, and encoded parameter string with an unencoded ampersand symbol (&):</p>
|
|
|
|
<p><code>GET&http%3A%2F%2Fwww.example.com%2Fwc-api%2Fv1%2Forders&oauth_consumer_key%3Dabc123%26oauth_signature_method%3DHMAC-SHA1</code></p>
|
|
|
|
<p>8) Generate the signature using the string to key and your consumer secret key</p>
|
|
|
|
<p>If you are having trouble generating a correct signature, you'll want to review your string to sign for errors with encoding. The <a href="https://github.com/woocommerce/woocommerce/blob/master/includes/class-wc-rest-authentication.php#L185">authentication source</a> can also be helpful in understanding how to properly generate the signature.</p>
|
|
<h4 id='oauth-tips'>OAuth Tips</h4>
|
|
<ul>
|
|
<li>The OAuth parameters may be added as query string parameters or included in the Authorization header.</li>
|
|
<li>Note there is no reliable cross-platform way to get the raw request headers in WordPress, so query string should be more reliable in some cases.</li>
|
|
<li>The required parameters are: <code>oauth_consumer_key</code>, <code>oauth_timestamp</code>, <code>oauth_nonce</code>, <code>oauth_signature</code>, and <code>oauth_signature_method</code>. <code>oauth_version</code> is not required and should be omitted.</li>
|
|
<li>The OAuth nonce can be any randomly generated 32 character (recommended) string that is unique to the consumer key.</li>
|
|
<li>The OAuth timestamp should be the unix timestamp at the time of the request. The REST API will deny any requests that include a timestamp outside of a 15 minute window to prevent replay attacks.</li>
|
|
<li>You must use the store URL provided by the index when forming the base string used for the signature, as this is what the server will use. (e.g. if the store URL includes a <code>www</code> sub-domain, you should use it for requests)</li>
|
|
<li>Note that the request body is <em>not</em> signed as per the OAuth spec.</li>
|
|
<li>If including parameters in your request, it saves a lot of trouble if you can order your items alphabetically.</li>
|
|
<li>Authorization header is supported starting WooCommerce 3.0.</li>
|
|
</ul>
|
|
<h2 id='parameters'>Parameters</h2>
|
|
<p>All endpoints accept optional parameters which can be passed as an HTTP query string parameter, e.g. <code>GET /orders?status=completed</code>. There are common parameters and endpoint-specific parameters which are documented along with that endpoint.</p>
|
|
<h3 id='filter-parameter'>Filter Parameter</h3>
|
|
<p>All endpoints accept a <code>filter</code> parameter that scopes individual filters using brackets, like date filtering:</p>
|
|
|
|
<p><code>GET /orders?filter[created_at_min]=2013-11-01</code></p>
|
|
|
|
<p>Multiple <code>filter</code> parameters can be included and intermixed with other parameters:</p>
|
|
|
|
<p><code>GET /orders?status=completed&filter[created_at_min]=2013-11-01&filter[created_at_max]=2013-11-30</code></p>
|
|
|
|
<p>Note that the following filters are supported for all endpoints except the <code>reports</code> endpoint, which has it's own set of filters that are documented along with that endpoint.</p>
|
|
<h4 id='available-filters'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>created_at_min</code></td>
|
|
<td>given a date, only resources <em>created after the provided date</em> will be returned</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at_max</code></td>
|
|
<td>given a date, only resources <em>created before the provided date</em> will be returned</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at_min</code></td>
|
|
<td>given a date, only resources <em>updated after the provided date</em> will be returned</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at_max</code></td>
|
|
<td>given a date, only resources <em>updated before the provided date</em> will be returned</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>q</code></td>
|
|
<td>performs a keyword search and returns resources that match, e.g. <code>GET /products?filter[q]=search-keyword</code>. Note that search terms should be URL-encoded as they will be decoded internally with <a href="http://us3.php.net/manual/en/function.urldecode.php"><code>urldecode</code></a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>controls the ordering of the resources returned, accepted values are <code>ASC</code> (default) or <code>DESC</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>controls the field that is used for ordering the resources returned. Accepts the same arguments as <a href="http://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters"><code>WP_Query</code></a>. Defaults to <code>date</code>. You can order by <code>meta_value</code> but you must provide <code>orderby_meta_key</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby_meta_key</code></td>
|
|
<td>the meta key to order returned resources by when using <code>orderby=meta_value</code>. For example, you could order products by price using <code>GET /products?filter[orderby]=meta_value_num&filter[orderby_meta_key]=_price</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>post_status</code></td>
|
|
<td>limits resources to only those with the specified post status. Most useful for returning unpublished products, e.g. <code>GET /products?filter[post_status]=draft</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta</code></td>
|
|
<td>resource meta is excluded by default, but it can be included by setting <code>meta=true</code>, e.g. <code>GET /orders?filter[meta]=true</code>. Protected meta (meta whose key is prefixed with an underscore) is not included in the response</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>pagination</code></td>
|
|
<td>explained below</td>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<p>Note that Dates should be provided in <a href="http://www.ietf.org/rfc/rfc3339.txt">RFC3339</a> format in UTC timezone: <code>YYYY-MM-DDTHH:MM:SSZ</code>. You may omit the time and timezone if desired.</p>
|
|
<h3 id='fields-parameter'>Fields Parameter</h3>
|
|
<p>You may limit the fields returned in the response using the <code>fields</code> parameter:</p>
|
|
|
|
<p><code>GET /orders?fields=id</code></p>
|
|
|
|
<p>To include multiple fields, separate them with commas:</p>
|
|
|
|
<p><code>GET /orders?fields=id,status</code></p>
|
|
|
|
<p>You can specify sub-fields using dot-notation:</p>
|
|
|
|
<p><code>GET /orders?fields=id,status,payment_details.method_title</code></p>
|
|
|
|
<p>Sub-fields can't be limited for resources that have multiple structs, like an order's line items. For example, this will return just the line items, but each line item will have the full set of information, not just the product ID:</p>
|
|
|
|
<p><code>GET /orders?fields=line_items.product_id</code></p>
|
|
<h2 id='pagination'>Pagination</h2>
|
|
<p>Requests that return multiple items will be paginated to 10 items by default. This default can be changed by the site administrator by changing the <code>posts_per_page</code> option. Alternatively the items per page can be specifed with the <code>?filter[limit]</code> parameter:</p>
|
|
|
|
<p><code>GET /orders?filter[limit]=15</code></p>
|
|
|
|
<p>You can specify further pages with the <code>?page</code> parameter:</p>
|
|
|
|
<p><code>GET /orders?page=2</code></p>
|
|
|
|
<p>You may also specify the offset from the first resource using the <code>?filter[offset]</code> parameter:</p>
|
|
|
|
<p><code>GET /orders?filter[offset]=5</code></p>
|
|
|
|
<p>Page number is 1-based and ommiting the <code>?page</code> parameter will return the first page.</p>
|
|
|
|
<p>The total number of resources and pages are always included in the <code>X-WC-Total</code> and <code>X-WC-TotalPages</code> HTTP headers.</p>
|
|
<h2 id='link-header'>Link Header</h2>
|
|
<p>Pagination info is included in the <a href="http://tools.ietf.org/html/rfc5988">Link Header</a>. It's recommended that you follow these values instead of building your own URLs where possible.</p>
|
|
<div class="highlight"><pre class="highlight plaintext"><code>Link: <https://www.example.com/wc-api/v1/products?page=2>; rel="next",
|
|
<https://www.example.com/wc-api/v1/products?page=3>; rel="last"`
|
|
</code></pre></div>
|
|
<p><em>Linebreak included for readability</em></p>
|
|
|
|
<p>The possible <code>rel</code> values are:</p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>Value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>next</code></td>
|
|
<td>Shows the URL of the immediate next page of results</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last</code></td>
|
|
<td>Shows the URL of the last page of results</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>first</code></td>
|
|
<td>Shows the URL of the first page of results</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>prev</code></td>
|
|
<td>Shows the URL of the immediate previous page of results</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='errors'>Errors</h2>
|
|
<p>Occasionally you might encounter errors when accessing the API. There are four possible types:</p>
|
|
|
|
<ul>
|
|
<li>Invalid requests, such as using an unsupported HTTP method will result in <code>400 Bad Request</code>.</li>
|
|
<li>Authentication or permission errors, such as incorrect API keys will result in <code>401 Unauthorized</code>.</li>
|
|
<li>Requests to resources that don't exist or are missing required parameters will result in <code>404 Not Found</code>.</li>
|
|
<li>Requests that cannot be processed due to a server error will result in <code>500 Internal Server Error</code>.</li>
|
|
</ul>
|
|
|
|
<blockquote>
|
|
<p><code>400 Bad Request</code> example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_unsupported_method"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"Unsupported request method"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p><code>401 Unauthorized</code> example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_authentication_error"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"Consumer Key is invalid"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p><code>404 Not Found</code> example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_invalid_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"Invalid order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p><code>500 Internal Server Error</code> example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_invalid_handler"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"The handler for the route is invalid"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<p>Errors return both an appropriate HTTP status code and response object which contains a <code>code</code> and <code>message</code> attribute. If an endpoint has any custom errors, they are documented with that endpoint.</p>
|
|
<h2 id='http-verbs'>HTTP Verbs</h2>
|
|
<p>The API uses the appropriate HTTP verb for each action:</p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>Verbe</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>HEAD</code></td>
|
|
<td>Can be used for any endpoint to return just the HTTP header information</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>GET</code></td>
|
|
<td>Used for retrieving resources</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>PUT</code></td>
|
|
<td>Used for updating resources</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>POST</code></td>
|
|
<td>Used for creating resources</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>DELETE</code></td>
|
|
<td>Used for deleting resources</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='jsonp-support'>JSONP Support</h2>
|
|
<p>The API supports JSONP by default. JSONP responses uses the <code>application/javascript</code> content-type. You can specify the callback using the <code>?_jsonp</code> parameter for <code>GET</code> requests to have the response wrapped in a JSON function:</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/count?_jsonp=ordersCount</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/count?_jsonp<span class="o">=</span>ordersCount <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>Response:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight plaintext"><code>\**\ordersCount({"count":8})
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>If the site administrator has chosen to disable it, you will receive a <code>400 Bad Request</code> error:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_jsonp_disabled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"JSONP support is disabled on this site"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p>If your callback contains invalid characters, you will receive a <code>400 Bad Request</code> error:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_jsonp_callback_invalid"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The JSONP callback function is invalid"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='webhooks'>Webhooks</h2>
|
|
<p>Webhooks are an experimental feature in the v2 REST API. They must be managed using the REST API endpoints as a UI is not yet available. The <code>WC_Webhook</code> class manages all data storage/retrieval from the custom post type, as well as enqueuing a webhook's actions and processing/delivering/logging the webhook. On <code>woocommerce_init</code>, active webhooks are loaded and their associated hooks are added.</p>
|
|
|
|
<p>Each webhook has:</p>
|
|
|
|
<ul>
|
|
<li>status: active (delivers payload), paused (delivery paused by admin), disabled (delivery paused by failure)</li>
|
|
<li>topic: determines which resource events the webhook is triggered for</li>
|
|
<li>delivery URL: URL where the payload is delivered, must be HTTP or HTTPS</li>
|
|
<li>secret: an optional secret key that is used to generate a HMAC-SHA256 hash of the request body so the receiver can verify authenticity of the webhook</li>
|
|
<li>hooks: an array of hook names that are added and bound to the webhook for processing</li>
|
|
</ul>
|
|
<h3 id='topics'>Topics</h3>
|
|
<p>The topic is a combination resource (e.g. order) and event (e.g. created) and maps to one or more hook names (e.g. <code>woocommerce_checkout_order_processed</code>). Webhooks can be created using the topic name and the appropriate hooks are automatically added.</p>
|
|
|
|
<p>Core topics are:</p>
|
|
|
|
<ul>
|
|
<li><code>coupon.created, coupon.updated, coupon.deleted</code></li>
|
|
<li><code>customer.created, customer.updated, customer.deleted</code></li>
|
|
<li><code>order.created, order.updated, order.deleted</code></li>
|
|
<li><code>product.created, product.updated, product.deleted</code></li>
|
|
</ul>
|
|
|
|
<p>Custom topics can also be used which map to a single hook name, so for example you could add a webhook with topic <code>action.woocommerce_add_to_cart</code> that is triggered on that event. Custom topics pass the first hook argument to the payload, so in this example the <code>cart_item_key</code> would be included in the payload.</p>
|
|
<h3 id='delivery-payload'>Delivery/Payload</h3>
|
|
<p>Delivery is done using <code>wp_remote_post()</code> (HTTP POST) and processed in the background by default using wp-cron. A few custom headers are added to the request to help the receiver process the webhook:</p>
|
|
|
|
<ul>
|
|
<li><code>X-WC-Webhook-Topic</code> - e.g. <code>order.updated</code></li>
|
|
<li><code>X-WC-Webhook-Resource</code> - e.g. <code>order</code></li>
|
|
<li><code>X-WC-Webhook-Event</code> - e.g. <code>updated</code></li>
|
|
<li><code>X-WC-Webhook-Signature</code> - a base64 encoded HMAC-SHA256 hash of the payload</li>
|
|
<li><code>X-WC-Webhook-ID</code> - webhook's post ID</li>
|
|
<li><code>X-WC-Delivery-ID</code> - delivery log ID (a comment)</li>
|
|
</ul>
|
|
|
|
<p>The payload is JSON encoded and for API resources (coupons,customers,orders,products), the response is exactly the same as if requested via the REST API.</p>
|
|
<h3 id='logging'>Logging</h3>
|
|
<p>Requests/responses are logged as comments on the webhook custom post type. Each delivery log includes:</p>
|
|
|
|
<ul>
|
|
<li>Request duration</li>
|
|
<li>Request URL, method, headers, and body</li>
|
|
<li>Response Code, message, headers, and body</li>
|
|
</ul>
|
|
|
|
<p>Only the 25 most recent delivery logs are kept in order to reduce comment table bloat.</p>
|
|
|
|
<p>After 5 consecutive failed deliveries (as defined by a non HTTP 2xx response code), the webhook is disabled and must be edited via the REST API to re-enable.</p>
|
|
|
|
<p>Delivery logs can be fetched through the REST API endpoint or in code using <code>WC_Webhook::get_delivery_logs()</code></p>
|
|
<h3 id='endpoints'>Endpoints</h3>
|
|
<p>See the webhook resource section.</p>
|
|
<h2 id='troubleshooting'>Troubleshooting</h2>
|
|
<ul>
|
|
<li>Nginx - Older configurations of Nginx can cause issues with the API, see <a href="https://github.com/woocommerce/woocommerce/issues/5616#issuecomment-47338737">this issue</a> for details</li>
|
|
</ul>
|
|
<h2 id='official-libraries'>Official Libraries</h2>
|
|
<ul>
|
|
<li><a href="https://www.npmjs.com/package/woocommerce-api">Node.js</a></li>
|
|
<li><a href="https://pypi.python.org/pypi/WooCommerce">Python</a></li>
|
|
<li><a href="https://packagist.org/packages/woothemes/woocommerce-api">PHP</a></li>
|
|
<li><a href="https://rubygems.org/gems/woocommerce_api">Ruby</a></li>
|
|
</ul>
|
|
<div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="c1">// Install:</span>
|
|
<span class="c1">// npm install --save woocommerce-api</span>
|
|
|
|
<span class="c1">// Setup:</span>
|
|
<span class="kd">var</span> <span class="nx">WooCommerceAPI</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">'</span><span class="s1">woocommerce-api</span><span class="dl">'</span><span class="p">);</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">WooCommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">WooCommerceAPI</span><span class="p">({</span>
|
|
<span class="na">url</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com</span><span class="dl">'</span><span class="p">,</span> <span class="c1">// Your store URL</span>
|
|
<span class="na">consumerKey</span><span class="p">:</span> <span class="dl">'</span><span class="s1">consumer_key</span><span class="dl">'</span><span class="p">,</span> <span class="c1">// Your consumer key</span>
|
|
<span class="na">consumerSecret</span><span class="p">:</span> <span class="dl">'</span><span class="s1">consumer_secret</span><span class="dl">'</span><span class="p">,</span> <span class="c1">// Your consumer secret</span>
|
|
<span class="na">version</span><span class="p">:</span> <span class="dl">'</span><span class="s1">v2</span><span class="dl">'</span> <span class="c1">// WooCommerce API version</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="c1"># Install:
|
|
# pip install woocommerce
|
|
</span>
|
|
<span class="c1"># Setup:
|
|
</span><span class="kn">from</span> <span class="nn">woocommerce</span> <span class="kn">import</span> <span class="n">API</span>
|
|
|
|
<span class="n">wcapi</span> <span class="o">=</span> <span class="n">API</span><span class="p">(</span>
|
|
<span class="n">url</span><span class="o">=</span><span class="s">"http://example.com"</span><span class="p">,</span>
|
|
<span class="n">consumer_key</span><span class="o">=</span><span class="s">"consumer_key"</span><span class="p">,</span>
|
|
<span class="n">consumer_secret</span><span class="o">=</span><span class="s">"consumer_secret"</span><span class="p">,</span>
|
|
<span class="n">version</span><span class="o">=</span><span class="s">"v2"</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="c1">// Install:</span>
|
|
<span class="c1">// composer require "woothemes/woocommerce-api:2.*"</span>
|
|
|
|
<span class="c1">// Setup:</span>
|
|
<span class="k">include_once</span><span class="p">(</span><span class="s1">'vendor/autoload.php'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$woocommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">WC_API_Client</span><span class="p">(</span>
|
|
<span class="s1">'http://example.com/'</span><span class="p">,</span>
|
|
<span class="s1">'consumer_key'</span><span class="p">,</span>
|
|
<span class="s1">'consumer_secret'</span>
|
|
<span class="p">);</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="c1"># Install:</span>
|
|
<span class="c1"># gem install woocommerce_api</span>
|
|
|
|
<span class="c1"># Setup:</span>
|
|
<span class="nb">require</span> <span class="s2">"woocommerce_api"</span>
|
|
|
|
<span class="n">woocommerce</span> <span class="o">=</span> <span class="no">WooCommerce</span><span class="o">::</span><span class="no">API</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span>
|
|
<span class="s2">"http://example.com"</span><span class="p">,</span>
|
|
<span class="s2">"consumer_key"</span><span class="p">,</span>
|
|
<span class="s2">"consumer_secret"</span><span class="p">,</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">version: </span><span class="s2">"v2"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div>
|
|
<aside class="notice">
|
|
Use the tabs at the top-right corner to see how to install and use each library.
|
|
</aside>
|
|
<h2 id='tools'>Tools</h2>
|
|
<ul>
|
|
<li><a href="http://mmattozzi.github.io/cocoa-rest-client/">CocoaRestClient</a> - A free, easy to use Mac OS X GUI client for interacting with the API, most useful when your test store has SSL enabled.</li>
|
|
<li><a href="https://itunes.apple.com/us/app/paw-http-client/id584653203?mt=12">Paw HTTP Client</a> - Another excellent HTTP client for Mac OS X.</li>
|
|
<li><a href="https://addons.mozilla.org/en-US/firefox/addon/restclient/">RESTClient, a debugger for RESTful web services</a> - Free Firefox add-on.</li>
|
|
<li><a href="https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo">Advanced REST client</a> - Free Google Chrome extension.</li>
|
|
</ul>
|
|
<h1 id='index'>Index</h1>
|
|
<p>The API index provides information about the endpoints available for the site, as well as store-specific information. No authentication is required to access the API index, however if the REST API is disabled, you will receive a <code>404 Not Found</code> error.</p>
|
|
|
|
<blockquote>
|
|
<p>404 Not Found response:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"errors"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_api_disabled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"The WooCommerce API is disabled on this site"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='index-properties'>Index Properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>The name of the site - <code>get_option( 'blogname' )</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>The site's description - <code>get_option( 'blogdescription' )</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>URL</code></td>
|
|
<td>string</td>
|
|
<td>The site's URL - <code>get_option( 'siteurl' )</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wc_version</code></td>
|
|
<td>string</td>
|
|
<td>The active WooCommerce version</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>routes</code></td>
|
|
<td>array</td>
|
|
<td>A list of available endpoints for the site keyed by relative URL. Each endpoint specifies the HTTP methods supported as well as the canonical URL</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta</code></td>
|
|
<td>array</td>
|
|
<td>A list of WooCommerce settings used in the API. See <a href="#meta-properties">Meta Properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='meta-properties'>Meta Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>currency</code></td>
|
|
<td>string</td>
|
|
<td>Currency ISO Code, e.g. <code>GBP</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency_format</code></td>
|
|
<td>string</td>
|
|
<td>Currency symbol, HTML encoded, e.g. <code>£</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency_position</code></td>
|
|
<td>string</td>
|
|
<td>Currency position, available the following options: <code>right</code>, <code>left</code>, <code>right_space</code> and <code>left_space</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>decimal_separator</code></td>
|
|
<td>string</td>
|
|
<td>Decimal separator, e.g <code>,</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dimension_unit</code></td>
|
|
<td>string</td>
|
|
<td>The unit set for product dimensions. Valid units are <code>cm</code>, <code>m</code>, <code>cm</code>, <code>mm</code>, <code>in</code>, and <code>yd</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>generate_password</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the API is able to auto generate passwords for new customers</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>links</code></td>
|
|
<td>array</td>
|
|
<td>API help links list</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>permalinks_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Whether pretty permalinks are enabled on the site, if this is false, the API will not function correctly</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price_num_decimals</code></td>
|
|
<td>integer</td>
|
|
<td>Number of decimals</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ssl_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>True if SSL is enabled for the site, false otherwise</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_included</code></td>
|
|
<td>boolean</td>
|
|
<td>True if prices include tax, false otherwise</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>thousand_separator</code></td>
|
|
<td>string</td>
|
|
<td>Thousands separator, e.g <code>.</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>timezone</code></td>
|
|
<td>string</td>
|
|
<td>The site's timezone</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>weight_unit</code></td>
|
|
<td>string</td>
|
|
<td>The unit set for product weights. Valid units are <code>kg</code>, <code>g</code>, <code>lbs</code>, <code>oz</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-index-list'>View Index List</h2>
|
|
<p>Retrieve a set of store information.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">''</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">""</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">index</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">""</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"store"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"URL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency_format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&#36;"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency_position"</span><span class="p">:</span><span class="w"> </span><span class="s2">"left_space"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"decimal_separator"</span><span class="p">:</span><span class="w"> </span><span class="s2">","</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimension_unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"in"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"generate_password"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"help"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://woocommerce.github.io/woocommerce-rest-api-docs/"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"permalinks_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_num_decimals"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ssl_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_included"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"thousand_separator"</span><span class="p">:</span><span class="w"> </span><span class="s2">"."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"timezone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"America/Sao_Paulo"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight_unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lbs"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WooCommerce Dev"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"routes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"/"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/coupons"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/coupons"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/coupons/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/coupons/bulk"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/coupons/bulk"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/coupons/code/<code>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/coupons/count"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/coupons/count"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/customers"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers/<id>/downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers/<id>/orders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers/bulk"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/customers/bulk"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers/count"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/customers/count"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/customers/email/<email>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/orders"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/<order_id>/notes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/<order_id>/notes/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/<order_id>/refunds"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/<order_id>/refunds/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/bulk"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/orders/bulk"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/count"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/orders/count"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/orders/statuses"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/orders/statuses"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/products"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/<id>/orders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/<id>/reviews"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/products/attributes"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/attributes/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/bulk"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/products/bulk"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/categories"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/products/categories"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/categories/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/count"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/products/count"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/products/sku/<sku>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/reports"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/reports"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/reports/sales"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/reports/sales"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/reports/sales/top_sellers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/reports/sales/top_sellers"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/webhooks"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/webhooks"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/webhooks/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"accepts_data"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PUT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PATCH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DELETE"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/webhooks/<webhook_id>/deliveries"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/webhooks/<webhook_id>/deliveries/<id>"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/webhooks/count"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wc-api/v2/webhooks/count"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"supports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"HEAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GET"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"wc_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.3.13"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h1 id='coupons'>Coupons</h1>
|
|
<p>This section lists all API that can be used to create, edit or otherwise manipulate coupons.</p>
|
|
<h2 id='coupon-properties'>Coupon Properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Coupon ID (post ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>code</code></td>
|
|
<td>string</td>
|
|
<td>Coupon code, always lowercase <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Coupon type, valid core types are: <code>fixed_cart</code>, <code>percent</code>, <code>fixed_product</code> and <code>percent_product</code>. Default is <code>fixed_cart</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the coupon was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the coupon was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>amount</code></td>
|
|
<td>string</td>
|
|
<td>The amount of discount</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>individual_use</code></td>
|
|
<td>boolean</td>
|
|
<td>Whether coupon can only be used individually</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_ids</code></td>
|
|
<td>array</td>
|
|
<td>Array of product ID's the coupon can be used on</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude_product_ids</code></td>
|
|
<td>array</td>
|
|
<td>Array of product ID's the coupon cannot be used on</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>usage_limit</code></td>
|
|
<td>integer</td>
|
|
<td>How many times the coupon can be used</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>usage_limit_per_user</code></td>
|
|
<td>integer</td>
|
|
<td>How many times the coupon can be user per customer</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>limit_usage_to_x_items</code></td>
|
|
<td>integer</td>
|
|
<td>Max number of items in the cart the coupon can be applied to</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>usage_count</code></td>
|
|
<td>integer</td>
|
|
<td>Number of times the coupon has been used already <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>expiry_date</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime`when the coupon expires</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enable_free_shipping</code></td>
|
|
<td>boolean</td>
|
|
<td>Is the coupon for free shipping</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_category_ids</code></td>
|
|
<td>array</td>
|
|
<td>Array of category ID's the coupon applies to</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude_product_category_ids</code></td>
|
|
<td>array</td>
|
|
<td>Array of category ID's the coupon does not apply to</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude_sale_items</code></td>
|
|
<td>boolean</td>
|
|
<td>Exclude sale items from the coupon</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>minimum_amount</code></td>
|
|
<td>string</td>
|
|
<td>Minimum order amount that needs to be in the cart before coupon applies</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>maximum_amount</code></td>
|
|
<td>string</td>
|
|
<td>Maximum order amount allowed when using the coupon</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_emails</code></td>
|
|
<td>array</td>
|
|
<td>Array of email addresses that can use this coupon</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Coupon description</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-coupon'>Create A Coupon</h2>
|
|
<p>This API helps you to create a new coupon.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/coupons</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/coupons <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"coupon": {
|
|
"code": "new-coupon",
|
|
"type": "percent",
|
|
"amount": "10",
|
|
"individual_use": true,
|
|
"product_ids": [],
|
|
"exclude_product_ids": [],
|
|
"usage_limit": "",
|
|
"usage_limit_per_user": "",
|
|
"limit_usage_to_x_items": "",
|
|
"expiry_date": "",
|
|
"enable_free_shipping": false,
|
|
"product_category_ids": [],
|
|
"exclude_product_category_ids": [],
|
|
"exclude_sale_items": true,
|
|
"minimum_amount": "100.00",
|
|
"maximum_amount": "0.00",
|
|
"customer_emails": [],
|
|
"description": ""
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">coupon</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">code</span><span class="p">:</span> <span class="dl">'</span><span class="s1">new-coupon</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">percent</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="dl">'</span><span class="s1">10</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">individual_use</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">product_ids</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="na">exclude_product_ids</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="na">usage_limit</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">usage_limit_per_user</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">limit_usage_to_x_items</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">expiry_date</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">enable_free_shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">product_category_ids</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="na">exclude_product_category_ids</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="na">exclude_sale_items</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">minimum_amount</span><span class="p">:</span> <span class="dl">'</span><span class="s1">100.00</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">maximum_amount</span><span class="p">:</span> <span class="dl">'</span><span class="s1">0.00</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">customer_emails</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">''</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">coupons</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"coupon"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"code"</span><span class="p">:</span> <span class="s">"new-coupon"</span><span class="p">,</span>
|
|
<span class="s">"type"</span><span class="p">:</span> <span class="s">"percent"</span><span class="p">,</span>
|
|
<span class="s">"amount"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
|
|
<span class="s">"individual_use"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"product_ids"</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="s">"exclude_product_ids"</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="s">"usage_limit"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"usage_limit_per_user"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"limit_usage_to_x_items"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"expiry_date"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"enable_free_shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"product_category_ids"</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="s">"exclude_product_category_ids"</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="s">"exclude_sale_items"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"minimum_amount"</span><span class="p">:</span> <span class="s">"100.00"</span><span class="p">,</span>
|
|
<span class="s">"maximum_amount"</span><span class="p">:</span> <span class="s">"0.00"</span><span class="p">,</span>
|
|
<span class="s">"customer_emails"</span><span class="p">:</span> <span class="p">[],</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">""</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"coupons"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'coupon'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'code'</span> <span class="o">=></span> <span class="s1">'new-coupon'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'percent'</span><span class="p">,</span>
|
|
<span class="s1">'amount'</span> <span class="o">=></span> <span class="s1">'10'</span><span class="p">,</span>
|
|
<span class="s1">'individual_use'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'product_ids'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(),</span>
|
|
<span class="s1">'exclude_product_ids'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(),</span>
|
|
<span class="s1">'usage_limit'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'usage_limit_per_user'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'limit_usage_to_x_items'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'expiry_date'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'enable_free_shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'product_category_ids'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(),</span>
|
|
<span class="s1">'exclude_product_category_ids'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(),</span>
|
|
<span class="s1">'exclude_sale_items'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'minimum_amount'</span> <span class="o">=></span> <span class="s1">'100.00'</span><span class="p">,</span>
|
|
<span class="s1">'maximum_amount'</span> <span class="o">=></span> <span class="s1">'0.00'</span><span class="p">,</span>
|
|
<span class="s1">'customer_emails'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(),</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">''</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">coupons</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">coupon: </span><span class="p">{</span>
|
|
<span class="ss">code: </span><span class="s2">"new-coupon"</span><span class="p">,</span>
|
|
<span class="ss">type: </span><span class="s2">"percent"</span><span class="p">,</span>
|
|
<span class="ss">amount: </span><span class="s2">"10"</span><span class="p">,</span>
|
|
<span class="ss">individual_use: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">product_ids: </span><span class="p">[],</span>
|
|
<span class="ss">exclude_product_ids: </span><span class="p">[],</span>
|
|
<span class="ss">usage_limit: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">usage_limit_per_user: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">limit_usage_to_x_items: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">expiry_date: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">enable_free_shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">product_category_ids: </span><span class="p">[],</span>
|
|
<span class="ss">exclude_product_category_ids: </span><span class="p">[],</span>
|
|
<span class="ss">exclude_sale_items: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">minimum_amount: </span><span class="s2">"100.00"</span><span class="p">,</span>
|
|
<span class="ss">maximum_amount: </span><span class="s2">"0.00"</span><span class="p">,</span>
|
|
<span class="ss">customer_emails: </span><span class="p">[],</span>
|
|
<span class="ss">description: </span><span class="s2">""</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"coupons"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"coupon"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">529</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new-coupon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"individual_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"usage_limit"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_limit_per_user"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"limit_usage_to_x_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"expiry_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enable_free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_sale_items"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"minimum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"100.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maximum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_emails"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-a-coupon'>View A Coupon</h2>
|
|
<p>This API lets you retrieve and view a specific coupon by ID or code.</p>
|
|
<h3 id='http-request-2'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/coupons/code/<code></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/coupons/529 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">coupons/529</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"coupons/529"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">coupons</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">529</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"coupons/529"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"coupon"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">529</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new-coupon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"individual_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"usage_limit"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_limit_per_user"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"limit_usage_to_x_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"expiry_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enable_free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_sale_items"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"minimum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"100.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maximum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_emails"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-coupons'>View List Of Coupons</h2>
|
|
<p>This API helps you to view all the coupons.</p>
|
|
<h3 id='http-request-3'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/coupons</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/coupons <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">coupons</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"coupons"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">coupons</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"coupons"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"coupons"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">529</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new-coupon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"individual_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"usage_limit"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_limit_per_user"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"limit_usage_to_x_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"expiry_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enable_free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_sale_items"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"minimum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"100.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maximum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_emails"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">527</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"free-shipping"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fixed_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T18:35:59Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T18:35:59Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"individual_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"usage_limit"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_limit_per_user"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"limit_usage_to_x_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"expiry_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enable_free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_sale_items"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"minimum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"50.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maximum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_emails"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">526</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"christmas-promo"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T18:10:58Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T18:10:58Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"individual_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"usage_limit"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_limit_per_user"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"limit_usage_to_x_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"expiry_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-12-25T00:00:00Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enable_free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_sale_items"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"minimum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"200.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maximum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_emails"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount for Christmas for orders over $ 200"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='update-a-coupon'>Update A Coupon</h2>
|
|
<p>This API lets you make changes to a coupon.</p>
|
|
<h3 id='http-request-4'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/coupons/529 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"coupon": {
|
|
"amount": "5"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">coupon</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="dl">'</span><span class="s1">5</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">coupons/529</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"coupon"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"amount"</span><span class="p">:</span> <span class="s">"5"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"coupons/529"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'coupon'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'amount'</span> <span class="o">=></span> <span class="s1">'5'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">coupons</span><span class="o">-></span><span class="nf">update</span><span class="p">(</span><span class="mi">529</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="p">{</span>
|
|
<span class="ss">coupon: </span><span class="p">{</span>
|
|
<span class="ss">amount: </span><span class="s2">"5"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"coupons/529"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"coupon"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">529</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"new-coupon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:05:27Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-20T19:10:33Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"individual_use"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"usage_limit"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_limit_per_user"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"limit_usage_to_x_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"usage_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"expiry_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enable_free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_product_category_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"exclude_sale_items"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"minimum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"100.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maximum_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_emails"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='delete-a-coupon'>Delete A Coupon</h2>
|
|
<p>This API helps you delete a coupon.</p>
|
|
<h3 id='http-request-5'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/coupons/529/?force<span class="o">=</span><span class="nb">true</span> <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">coupons/529/?force=true</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"coupons/529"</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="p">{</span><span class="s">"force"</span><span class="p">:</span> <span class="bp">True</span><span class="p">}).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">coupons</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">529</span><span class="p">,</span> <span class="kc">true</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"coupons/529, force: true).parsed_response
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted coupon"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='parameters'>Parameters</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>force</code></td>
|
|
<td>string</td>
|
|
<td>Use <code>true</code> whether to permanently delete the coupon, defaults to <code>false</code>. Note that permanently deleting the coupon will return HTTP 200 rather than HTTP 202.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-coupons-count'>View Coupons Count</h2>
|
|
<p>This API lets you retrieve a count of all coupons.</p>
|
|
<h3 id='http-request-6'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/coupons/count</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/coupons/count <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">coupons/count</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"coupons/count"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">coupons</span><span class="o">-></span><span class="nf">get_count</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"coupons/count"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h1 id='customers'>Customers</h1>
|
|
<p>This section lists all API that can be used to create, edit or otherwise manipulate customers.</p>
|
|
<h2 id='customers-properties'>Customers Properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Customer ID (user ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the customer was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>email</code></td>
|
|
<td>string</td>
|
|
<td>Customer email address <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>first_name</code></td>
|
|
<td>string</td>
|
|
<td>Customer first name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last_name</code></td>
|
|
<td>string</td>
|
|
<td>Customer last name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>username</code></td>
|
|
<td>string</td>
|
|
<td>Customer username, can be generated automatically from the customer's email addrees if the option <code>woocommerce_registration_generate_username</code> is equal to <code>yes</code> <i class="label label-info">cannot be changed</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>password</code></td>
|
|
<td>string</td>
|
|
<td>Customer password, can be generated automatically with <a href="http://codex.wordpress.org/Function_Reference/wp_generate_password"><code>wp_generate_password()</code></a> if the "Automatically generate customer password" option is enabled, check the index meta for <code>generate_password</code> <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last_order_id</code></td>
|
|
<td>integer</td>
|
|
<td>Last order ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last_order_date</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime of the customer last order <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orders_count</code></td>
|
|
<td>integer</td>
|
|
<td>Quantity of orders that the customer have <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_spent</code></td>
|
|
<td>integer</td>
|
|
<td>Total amount spent <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>avatar_url</code></td>
|
|
<td>string</td>
|
|
<td>Gravatar URL</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>billing_address</code></td>
|
|
<td>array</td>
|
|
<td>List of Billing Address fields. See <a href="#billing-address-properties">Billing Address Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_address</code></td>
|
|
<td>array</td>
|
|
<td>List of Shipping Address fields. See <a href="#shipping-address-properties">Shipping Address Properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='billing-address-properties'>Billing Address Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>first_name</code></td>
|
|
<td>string</td>
|
|
<td>First name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last_name</code></td>
|
|
<td>string</td>
|
|
<td>Last name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>company</code></td>
|
|
<td>string</td>
|
|
<td>Company name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>address_1</code></td>
|
|
<td>string</td>
|
|
<td>Address line 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>address_2</code></td>
|
|
<td>string</td>
|
|
<td>Address line 2</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>city</code></td>
|
|
<td>string</td>
|
|
<td>City name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>state</code></td>
|
|
<td>string</td>
|
|
<td>ISO code or name of the state, province or district</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>postcode</code></td>
|
|
<td>string</td>
|
|
<td>Postal code</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>country</code></td>
|
|
<td>string</td>
|
|
<td>ISO code of the country</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>email</code></td>
|
|
<td>string</td>
|
|
<td>Email address</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>phone</code></td>
|
|
<td>string</td>
|
|
<td>Phone</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='shipping-address-properties'>Shipping Address Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>first_name</code></td>
|
|
<td>string</td>
|
|
<td>First name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last_name</code></td>
|
|
<td>string</td>
|
|
<td>Last name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>company</code></td>
|
|
<td>string</td>
|
|
<td>Company name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>address_1</code></td>
|
|
<td>string</td>
|
|
<td>Address line 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>address_2</code></td>
|
|
<td>string</td>
|
|
<td>Address line 2</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>city</code></td>
|
|
<td>string</td>
|
|
<td>City name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>state</code></td>
|
|
<td>string</td>
|
|
<td>ISO code or name of the state, province or district</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>postcode</code></td>
|
|
<td>string</td>
|
|
<td>Postal code</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>country</code></td>
|
|
<td>string</td>
|
|
<td>ISO code of the country</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-customer'>Create A Customer</h2>
|
|
<p>This API helps you to create a new customer.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/customers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/customers <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"customer": {
|
|
"email": "john.doe@example.com",
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"username": "john.doe",
|
|
"billing_address": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"company": "",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US",
|
|
"email": "john.doe@example.com",
|
|
"phone": "(555) 555-5555"
|
|
},
|
|
"shipping_address": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"company": "",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US"
|
|
}
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">customer</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">'</span><span class="s1">john.doe@example.com</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">John</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">last_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Doe</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">username</span><span class="p">:</span> <span class="dl">'</span><span class="s1">john.doe</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">billing_address</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">John</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">last_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Doe</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">company</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">address_1</span><span class="p">:</span> <span class="dl">'</span><span class="s1">969 Market</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">address_2</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">city</span><span class="p">:</span> <span class="dl">'</span><span class="s1">San Francisco</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">'</span><span class="s1">CA</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">postcode</span><span class="p">:</span> <span class="dl">'</span><span class="s1">94103</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">'</span><span class="s1">US</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">'</span><span class="s1">john.doe@example.com</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">phone</span><span class="p">:</span> <span class="dl">'</span><span class="s1">(555) 555-5555</span><span class="dl">'</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping_address</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">John</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">last_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Doe</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">company</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">address_1</span><span class="p">:</span> <span class="dl">'</span><span class="s1">969 Market</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">address_2</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">city</span><span class="p">:</span> <span class="dl">'</span><span class="s1">San Francisco</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">'</span><span class="s1">CA</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">postcode</span><span class="p">:</span> <span class="dl">'</span><span class="s1">94103</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">'</span><span class="s1">US</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"customer"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@example.com"</span><span class="p">,</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"John"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Doe"</span><span class="p">,</span>
|
|
<span class="s">"username"</span><span class="p">:</span> <span class="s">"john.doe"</span><span class="p">,</span>
|
|
<span class="s">"billing_address"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"John"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Doe"</span><span class="p">,</span>
|
|
<span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"address_1"</span><span class="p">:</span> <span class="s">"969 Market"</span><span class="p">,</span>
|
|
<span class="s">"address_2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"city"</span><span class="p">:</span> <span class="s">"San Francisco"</span><span class="p">,</span>
|
|
<span class="s">"state"</span><span class="p">:</span> <span class="s">"CA"</span><span class="p">,</span>
|
|
<span class="s">"postcode"</span><span class="p">:</span> <span class="s">"94103"</span><span class="p">,</span>
|
|
<span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
|
|
<span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@example.com"</span><span class="p">,</span>
|
|
<span class="s">"phone"</span><span class="p">:</span> <span class="s">"(555) 555-5555"</span>
|
|
<span class="p">},</span>
|
|
<span class="s">"shipping_address"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"John"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Doe"</span><span class="p">,</span>
|
|
<span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"address_1"</span><span class="p">:</span> <span class="s">"969 Market"</span><span class="p">,</span>
|
|
<span class="s">"address_2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"city"</span><span class="p">:</span> <span class="s">"San Francisco"</span><span class="p">,</span>
|
|
<span class="s">"state"</span><span class="p">:</span> <span class="s">"CA"</span><span class="p">,</span>
|
|
<span class="s">"postcode"</span><span class="p">:</span> <span class="s">"94103"</span><span class="p">,</span>
|
|
<span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"customers"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'customer'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john.doe@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'John'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Doe'</span><span class="p">,</span>
|
|
<span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'john.doe'</span><span class="p">,</span>
|
|
<span class="s1">'billing_address'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'John'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Doe'</span><span class="p">,</span>
|
|
<span class="s1">'company'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'address_1'</span> <span class="o">=></span> <span class="s1">'969 Market'</span><span class="p">,</span>
|
|
<span class="s1">'address_2'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'city'</span> <span class="o">=></span> <span class="s1">'San Francisco'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'CA'</span><span class="p">,</span>
|
|
<span class="s1">'postcode'</span> <span class="o">=></span> <span class="s1">'94103'</span><span class="p">,</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'US'</span><span class="p">,</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john.doe@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'phone'</span> <span class="o">=></span> <span class="s1">'(555) 555-5555'</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'shipping_address'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'John'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Doe'</span><span class="p">,</span>
|
|
<span class="s1">'company'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'address_1'</span> <span class="o">=></span> <span class="s1">'969 Market'</span><span class="p">,</span>
|
|
<span class="s1">'address_2'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'city'</span> <span class="o">=></span> <span class="s1">'San Francisco'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'CA'</span><span class="p">,</span>
|
|
<span class="s1">'postcode'</span> <span class="o">=></span> <span class="s1">'94103'</span><span class="p">,</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'US'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">customer: </span><span class="p">{</span>
|
|
<span class="ss">email: </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span>
|
|
<span class="ss">first_name: </span><span class="s2">"John"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Doe"</span><span class="p">,</span>
|
|
<span class="ss">username: </span><span class="s2">"john.doe"</span><span class="p">,</span>
|
|
<span class="ss">billing_address: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"John"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Doe"</span><span class="p">,</span>
|
|
<span class="ss">company: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">address_1: </span><span class="s2">"969 Market"</span><span class="p">,</span>
|
|
<span class="ss">address_2: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">city: </span><span class="s2">"San Francisco"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CA"</span><span class="p">,</span>
|
|
<span class="ss">postcode: </span><span class="s2">"94103"</span><span class="p">,</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">email: </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span>
|
|
<span class="ss">phone: </span><span class="s2">"(555) 555-5555"</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">shipping_address: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"John"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Doe"</span><span class="p">,</span>
|
|
<span class="ss">company: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">address_1: </span><span class="s2">"969 Market"</span><span class="p">,</span>
|
|
<span class="ss">address_2: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">city: </span><span class="s2">"San Francisco"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CA"</span><span class="p">,</span>
|
|
<span class="ss">postcode: </span><span class="s2">"94103"</span><span class="p">,</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"customers"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-05T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-a-customer'>View A Customer</h2>
|
|
<p>This API lets you retrieve and view a specific customer by ID or email.</p>
|
|
<h3 id='http-request-2'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/customers/email/<email></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/customers/2 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers/2</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"customers/2"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">2</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"customers/2"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-05T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-customers'>View List Of Customers</h2>
|
|
<p>This API helps you to view all the customers.</p>
|
|
<h3 id='http-request-3'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/customers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/customers <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"customers"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"customers"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"customers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-05T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">123</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-14T16:47:30Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1034.58"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-10T14:25:39Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"joao.silva@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"João"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Silva"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"joao.silva"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">120</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-10T14:26:30Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"429.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"João"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Silva"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Av. Brasil, 432"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rio de Janeiro"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"RJ"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12345-000"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"joao.silva@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(55) 5555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"João"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Silva"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Av. Brasil, 432"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rio de Janeiro"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"RJ"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12345-000"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BR"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>role</code></td>
|
|
<td>string</td>
|
|
<td>Customers by status. eg: <code>customer</code> or <code>subscriber</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-customer'>Update A Customer</h2>
|
|
<p>This API lets you make changes to a customer.</p>
|
|
<h3 id='http-request-4'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/customers/2 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"customer": {
|
|
"first_name": "James",
|
|
"billing_address": {
|
|
"first_name": "James"
|
|
},
|
|
"shipping_address": {
|
|
"first_name": "James"
|
|
}
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">customer</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">James</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">billing_address</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">James</span><span class="dl">'</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping_address</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">James</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers/2</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"customer"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"James"</span><span class="p">,</span>
|
|
<span class="s">"billing_address"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"James"</span>
|
|
<span class="p">},</span>
|
|
<span class="s">"shipping_address"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"James"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"customers/2"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'customer'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'James'</span><span class="p">,</span>
|
|
<span class="s1">'billing_address'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'James'</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'shipping_address'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'James'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">update</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">customer: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"James"</span><span class="p">,</span>
|
|
<span class="ss">billing_address: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"James"</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">shipping_address: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"James"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"customers/2"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-05T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"James"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='delete-a-customer'>Delete A Customer</h2>
|
|
<p>This API helps you delete a customer.</p>
|
|
<h3 id='http-request-5'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/customers/2 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers/2</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"customers/2"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">2</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"customers/2"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted customer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-customer-orders'>View Customer Orders</h2>
|
|
<p>This API lets you retrieve the customers orders.</p>
|
|
<h3 id='http-request-6'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/customers/<id>/orders</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/customers/2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers/2/orders</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"customers/2/orders"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">get_orders</span><span class="p">(</span><span class="mi">2</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"customers/2/orders"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"orders"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">531</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">531</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T12:02:13Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T12:02:13Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T12:02:13Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"on-hold"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"30.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_line_items_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_methods"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"payment_details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bacs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"paid"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"127.0.0.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"view_order_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/my-account/view-order/531"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">417</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">19</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"shipping_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">418</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tax_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"fee_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"coupon_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-19T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"531"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T12:02:13Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#orders-properties">Orders Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='view-customer-downloads'>View Customer Downloads</h2>
|
|
<p>This API lets you retrieve the customers downloads.</p>
|
|
<h3 id='http-request-7'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/customers/<id>/downloads</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/customers/2/downloads <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers/2/downloads</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"customers/2/downloads"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">get_downloads</span><span class="p">(</span><span class="mi">2</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"customers/2/downloads"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"download_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/?download_file=96&order=wc_order_9999999999999&email=john.doe@example.com&key=99999999999999999999999999999999"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"99999999999999999999999999999999"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">96</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #4 &ndash; Woo Album"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">532</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_9999999999999"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloads_remaining"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"access_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"file"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"file"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/woocommerce_uploads/2015/01/album.zip"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='customer-downloads-properties'>Customer Downloads Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>download_url</code></td>
|
|
<td>string</td>
|
|
<td>Download file URL</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_id</code></td>
|
|
<td>string</td>
|
|
<td>Download ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_id</code></td>
|
|
<td>integer</td>
|
|
<td>Downloadable product ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_name</code></td>
|
|
<td>string</td>
|
|
<td>Downloadable file name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_id</code></td>
|
|
<td>integer</td>
|
|
<td>Order ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_key</code></td>
|
|
<td>string</td>
|
|
<td>Order Key</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads_remaining</code></td>
|
|
<td>string</td>
|
|
<td>Amount of downloads remaining. An empty string means that is "Unlimited"</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>access_expires</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the download access expires. <code>null</code> means "Never"</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file</code></td>
|
|
<td>array</td>
|
|
<td>List for downloadable files, each one have a <code>name</code> (file name) and <code>file</code> (file URL) attribute</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-customers-count'>View Customers Count</h2>
|
|
<p>This API lets you retrieve a count of all customers.</p>
|
|
<h3 id='http-request-8'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/customers/count</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/customers/count <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">customers/count</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"customers/count"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">customers</span><span class="o">-></span><span class="nf">get_count</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"customers/count"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters-2'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>role</code></td>
|
|
<td>string</td>
|
|
<td>Customers by status. eg: <code>customer</code> or <code>subscriber</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h1 id='orders'>Orders</h1>
|
|
<p>This section lists all API that can be used to create, edit or otherwise manipulate orders.</p>
|
|
<h2 id='orders-properties'>Orders Properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Order ID (post ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_number</code></td>
|
|
<td>integer</td>
|
|
<td>Order number <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the order was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the order was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>completed_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the order was last completed <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Order status. By default are available the status: <code>pending</code>, <code>processing</code>, <code>on-hold</code>, <code>completed</code>, <code>cancelled</code>, <code>refunded</code> and <code>failed</code>. See <a href="#view-list-of-order-statuses">View List of Order Statuses</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency</code></td>
|
|
<td>string</td>
|
|
<td>Currency in ISO format, e.g <code>USD</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Order total <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subtotal</code></td>
|
|
<td>string</td>
|
|
<td>Order subtotal <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_line_items_quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Total of order items <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Order tax total <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_shipping</code></td>
|
|
<td>string</td>
|
|
<td>Order shipping total <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>cart_tax</code></td>
|
|
<td>string</td>
|
|
<td>Order cart tax <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_tax</code></td>
|
|
<td>string</td>
|
|
<td>Order shipping tax <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_discount</code></td>
|
|
<td>string</td>
|
|
<td>Order total discount <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_methods</code></td>
|
|
<td>string</td>
|
|
<td>Text list of the shipping methods used in the order <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>payment_details</code></td>
|
|
<td>array</td>
|
|
<td>List of payment details. See <a href="#payment-details-properties">Payment Details Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>billing_address</code></td>
|
|
<td>array</td>
|
|
<td>List of customer billing address. See <a href="#billing-address-properties">Customer Billing Address Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_address</code></td>
|
|
<td>array</td>
|
|
<td>List of customer shipping address. See <a href="#shipping-address-properties">Customer Shipping Address Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>note</code></td>
|
|
<td>string</td>
|
|
<td>Customer order notes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_ip</code></td>
|
|
<td>string</td>
|
|
<td>Customer IP address <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_user_agent</code></td>
|
|
<td>string</td>
|
|
<td>Customer User-Agent <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_id</code></td>
|
|
<td>integer</td>
|
|
<td>Customer ID (user ID) <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>view_order_url</code></td>
|
|
<td>string</td>
|
|
<td>URL to view the order in frontend <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>line_items</code></td>
|
|
<td>array</td>
|
|
<td>List of order line items. See <a href="#line-items-properties">Line Items Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_lines</code></td>
|
|
<td>array</td>
|
|
<td>List of shipping line items. See <a href="#shipping-lines-properties">Shipping Lines Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_lines</code></td>
|
|
<td>array</td>
|
|
<td>List of tax line items. See <a href="#tax-lines-properties">Tax Lines Properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fee_lines</code></td>
|
|
<td>array</td>
|
|
<td>List of fee line items. See <a href="#fee-lines-properites">Fee Lines Properites</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>coupon_lines</code></td>
|
|
<td>array</td>
|
|
<td>List of cupon line items. See <a href="#coupon-lines-properties">Coupon Lines Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer</code></td>
|
|
<td>array</td>
|
|
<td>Customer data. See <a href="#customers-properties">Customer Properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='payment-details-properties'>Payment Details Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>method_id</code></td>
|
|
<td>string</td>
|
|
<td>Payment method ID <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_title</code></td>
|
|
<td>string</td>
|
|
<td>Payment method title <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>paid</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows/define if the order is paid using this payment method. Use <code>true</code> to complate the payment.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>transaction_id</code></td>
|
|
<td>string</td>
|
|
<td>Transaction ID, an optional field to set the transacion ID when complate one payment (to set this you need set the <code>paid</code> as <code>true</code> too)</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='line-items-properties'>Line Items Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Line item ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subtotal</code></td>
|
|
<td>string</td>
|
|
<td>Line item subtotal</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subtotal_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line item tax subtotal</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Line item total</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line item tax total</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price</code></td>
|
|
<td>string</td>
|
|
<td>Product price <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Quantity</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Product tax class <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Product name <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_id</code></td>
|
|
<td>integer</td>
|
|
<td>Product ID <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Product SKU <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta</code></td>
|
|
<td>array</td>
|
|
<td>List of product meta items. See <a href="#products-meta-items-properties">Products Meta Items Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variations</code></td>
|
|
<td>array</td>
|
|
<td>List of product variation attributes. e.g: <code>"variation": {"pa_color": "Black", "pa_size": "XGG"}</code> (Use <code>pa_</code> prefix when is a product attribute) <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='products-meta-items-properties'>Products Meta Items Properties</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta item key</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>label</code></td>
|
|
<td>string</td>
|
|
<td>Meta item label</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta item value</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='shipping-lines-properties'>Shipping Lines Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Shipping line ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_id</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method ID <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_title</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method title <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Total amount</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='tax-lines-properties'>Tax Lines Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Tax rate line ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rate_id</code></td>
|
|
<td>integer</td>
|
|
<td>Tax rate ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>code</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate code <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate title/name <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate total <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>compound</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if is or not a compound rate. Compound tax rates are applied on top of other tax rates. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='fee-lines-properites'>Fee Lines Properites</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Fee line ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method title <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxable</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows/define if the fee is taxable <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class, requered in write-mode if the fee is taxable</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Total amount</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Tax total</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='coupon-lines-properties'>Coupon Lines Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Coupon line ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>code</code></td>
|
|
<td>string</td>
|
|
<td>Coupon code <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>amount</code></td>
|
|
<td>string</td>
|
|
<td>Total amount <i class="label label-info">required</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-an-order'>Create An Order</h2>
|
|
<p>This API helps you to create a new order.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/orders</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of create a paid order:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"order": {
|
|
"payment_details": {
|
|
"method_id": "bacs",
|
|
"method_title": "Direct Bank Transfer",
|
|
"paid": true
|
|
},
|
|
"billing_address": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US",
|
|
"email": "john.doe@example.com",
|
|
"phone": "(555) 555-5555"
|
|
},
|
|
"shipping_address": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US"
|
|
},
|
|
"customer_id": 2,
|
|
"line_items": [
|
|
{
|
|
"product_id": 546,
|
|
"quantity": 2
|
|
},
|
|
{
|
|
"product_id": 613,
|
|
"quantity": 1,
|
|
"variations": {
|
|
"pa_color": "Black"
|
|
}
|
|
}
|
|
],
|
|
"shipping_lines": [
|
|
{
|
|
"method_id": "flat_rate",
|
|
"method_title": "Flat Rate",
|
|
"total": "10.00"
|
|
}
|
|
]
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">payment_details</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">method_id</span><span class="p">:</span> <span class="dl">'</span><span class="s1">bacs</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">method_title</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Direct Bank Transfer</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">paid</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">},</span>
|
|
<span class="na">billing_address</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">John</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">last_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Doe</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">address_1</span><span class="p">:</span> <span class="dl">'</span><span class="s1">969 Market</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">address_2</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">city</span><span class="p">:</span> <span class="dl">'</span><span class="s1">San Francisco</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">'</span><span class="s1">CA</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">postcode</span><span class="p">:</span> <span class="dl">'</span><span class="s1">94103</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">'</span><span class="s1">US</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">'</span><span class="s1">john.doe@example.com</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">phone</span><span class="p">:</span> <span class="dl">'</span><span class="s1">(555) 555-5555</span><span class="dl">'</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping_address</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">John</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">last_name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Doe</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">address_1</span><span class="p">:</span> <span class="dl">'</span><span class="s1">969 Market</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">address_2</span><span class="p">:</span> <span class="dl">''</span><span class="p">,</span>
|
|
<span class="na">city</span><span class="p">:</span> <span class="dl">'</span><span class="s1">San Francisco</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">'</span><span class="s1">CA</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">postcode</span><span class="p">:</span> <span class="dl">'</span><span class="s1">94103</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">'</span><span class="s1">US</span><span class="dl">'</span>
|
|
<span class="p">},</span>
|
|
<span class="na">customer_id</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
|
<span class="na">line_items</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">product_id</span><span class="p">:</span> <span class="mi">546</span><span class="p">,</span>
|
|
<span class="na">quantity</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">product_id</span><span class="p">:</span> <span class="mi">613</span><span class="p">,</span>
|
|
<span class="na">quantity</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
<span class="na">variations</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">pa_color</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Black</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">shipping_lines</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">method_id</span><span class="p">:</span> <span class="dl">'</span><span class="s1">flat_rate</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">method_title</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Flat Rate</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">total</span><span class="p">:</span> <span class="dl">'</span><span class="s1">10.00</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"payment_details"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"method_id"</span><span class="p">:</span> <span class="s">"bacs"</span><span class="p">,</span>
|
|
<span class="s">"method_title"</span><span class="p">:</span> <span class="s">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="s">"paid"</span><span class="p">:</span> <span class="bp">True</span>
|
|
<span class="p">},</span>
|
|
<span class="s">"billing_address"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"John"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Doe"</span><span class="p">,</span>
|
|
<span class="s">"address_1"</span><span class="p">:</span> <span class="s">"969 Market"</span><span class="p">,</span>
|
|
<span class="s">"address_2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"city"</span><span class="p">:</span> <span class="s">"San Francisco"</span><span class="p">,</span>
|
|
<span class="s">"state"</span><span class="p">:</span> <span class="s">"CA"</span><span class="p">,</span>
|
|
<span class="s">"postcode"</span><span class="p">:</span> <span class="s">"94103"</span><span class="p">,</span>
|
|
<span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
|
|
<span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@example.com"</span><span class="p">,</span>
|
|
<span class="s">"phone"</span><span class="p">:</span> <span class="s">"(555) 555-5555"</span>
|
|
<span class="p">},</span>
|
|
<span class="s">"shipping_address"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"John"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Doe"</span><span class="p">,</span>
|
|
<span class="s">"address_1"</span><span class="p">:</span> <span class="s">"969 Market"</span><span class="p">,</span>
|
|
<span class="s">"address_2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
|
|
<span class="s">"city"</span><span class="p">:</span> <span class="s">"San Francisco"</span><span class="p">,</span>
|
|
<span class="s">"state"</span><span class="p">:</span> <span class="s">"CA"</span><span class="p">,</span>
|
|
<span class="s">"postcode"</span><span class="p">:</span> <span class="s">"94103"</span><span class="p">,</span>
|
|
<span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span>
|
|
<span class="p">},</span>
|
|
<span class="s">"customer_id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
|
<span class="s">"line_items"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"product_id"</span><span class="p">:</span> <span class="mi">546</span><span class="p">,</span>
|
|
<span class="s">"quantity"</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"product_id"</span><span class="p">:</span> <span class="mi">613</span><span class="p">,</span>
|
|
<span class="s">"quantity"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
<span class="s">"variations"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"pa_color"</span><span class="p">:</span> <span class="s">"Black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"shipping_lines"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"method_id"</span><span class="p">:</span> <span class="s">"flat_rate"</span><span class="p">,</span>
|
|
<span class="s">"method_title"</span><span class="p">:</span> <span class="s">"Flat Rate"</span><span class="p">,</span>
|
|
<span class="s">"total"</span><span class="p">:</span> <span class="s">"10.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"orders"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'payment_details'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'method_id'</span> <span class="o">=></span> <span class="s1">'bacs'</span><span class="p">,</span>
|
|
<span class="s1">'method_title'</span> <span class="o">=></span> <span class="s1">'Direct Bank Transfer'</span><span class="p">,</span>
|
|
<span class="s1">'paid'</span> <span class="o">=></span> <span class="kc">true</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'billing_address'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'John'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Doe'</span><span class="p">,</span>
|
|
<span class="s1">'address_1'</span> <span class="o">=></span> <span class="s1">'969 Market'</span><span class="p">,</span>
|
|
<span class="s1">'address_2'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'city'</span> <span class="o">=></span> <span class="s1">'San Francisco'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'CA'</span><span class="p">,</span>
|
|
<span class="s1">'postcode'</span> <span class="o">=></span> <span class="s1">'94103'</span><span class="p">,</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'US'</span><span class="p">,</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john.doe@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'phone'</span> <span class="o">=></span> <span class="s1">'(555) 555-5555'</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'shipping_address'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'John'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Doe'</span><span class="p">,</span>
|
|
<span class="s1">'address_1'</span> <span class="o">=></span> <span class="s1">'969 Market'</span><span class="p">,</span>
|
|
<span class="s1">'address_2'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span>
|
|
<span class="s1">'city'</span> <span class="o">=></span> <span class="s1">'San Francisco'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'CA'</span><span class="p">,</span>
|
|
<span class="s1">'postcode'</span> <span class="o">=></span> <span class="s1">'94103'</span><span class="p">,</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'US'</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'customer_id'</span> <span class="o">=></span> <span class="mi">2</span><span class="p">,</span>
|
|
<span class="s1">'line_items'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">546</span><span class="p">,</span>
|
|
<span class="s1">'quantity'</span> <span class="o">=></span> <span class="mi">2</span>
|
|
<span class="p">),</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">613</span><span class="p">,</span>
|
|
<span class="s1">'quantity'</span> <span class="o">=></span> <span class="mi">1</span><span class="p">,</span>
|
|
<span class="s1">'variations'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'pa_color'</span> <span class="o">=></span> <span class="s1">'Black'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'shipping_lines'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'method_id'</span> <span class="o">=></span> <span class="s1">'flat_rate'</span><span class="p">,</span>
|
|
<span class="s1">'method_title'</span> <span class="o">=></span> <span class="s1">'Flat Rate'</span><span class="p">,</span>
|
|
<span class="s1">'total'</span> <span class="o">=></span> <span class="s1">'10.00'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order: </span><span class="p">{</span>
|
|
<span class="ss">payment_details: </span><span class="p">{</span>
|
|
<span class="ss">method_id: </span><span class="s2">"bacs"</span><span class="p">,</span>
|
|
<span class="ss">method_title: </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="ss">paid: </span><span class="kp">true</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">billing_address: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"John"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Doe"</span><span class="p">,</span>
|
|
<span class="ss">address_1: </span><span class="s2">"969 Market"</span><span class="p">,</span>
|
|
<span class="ss">address_2: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">city: </span><span class="s2">"San Francisco"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CA"</span><span class="p">,</span>
|
|
<span class="ss">postcode: </span><span class="s2">"94103"</span><span class="p">,</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">email: </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span>
|
|
<span class="ss">phone: </span><span class="s2">"(555) 555-5555"</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">shipping_address: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"John"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Doe"</span><span class="p">,</span>
|
|
<span class="ss">address_1: </span><span class="s2">"969 Market"</span><span class="p">,</span>
|
|
<span class="ss">address_2: </span><span class="s2">""</span><span class="p">,</span>
|
|
<span class="ss">city: </span><span class="s2">"San Francisco"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CA"</span><span class="p">,</span>
|
|
<span class="ss">postcode: </span><span class="s2">"94103"</span><span class="p">,</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">customer_id: </span><span class="mi">2</span><span class="p">,</span>
|
|
<span class="ss">line_items: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">546</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">613</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</span><span class="p">,</span>
|
|
<span class="ss">variations: </span><span class="p">{</span>
|
|
<span class="ss">pa_color: </span><span class="s2">"Black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">shipping_lines: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">method_id: </span><span class="s2">"flat_rate"</span><span class="p">,</span>
|
|
<span class="ss">method_title: </span><span class="s2">"Flat Rate"</span><span class="p">,</span>
|
|
<span class="ss">total: </span><span class="s2">"10.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"orders"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"processing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"79.87"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"63.97"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_line_items_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.90"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_methods"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"payment_details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bacs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"paid"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"127.0.0.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordPress/4.1; http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"view_order_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/my-account/view-order/645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">504</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reduced-rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">505</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">613</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pa_color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Black"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"shipping_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">506</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tax_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">507</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-TAX-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">508</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-STANDARD-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"fee_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"coupon_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-19T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-an-order'>View An Order</h2>
|
|
<p>This API lets you retrieve and view a specific order.</p>
|
|
<h3 id='http-request-2'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/645 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/645"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">645</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/645"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"processing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"79.87"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"63.97"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_line_items_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.90"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_methods"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"payment_details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bacs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"paid"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"127.0.0.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordPress/4.1; http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"view_order_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/my-account/view-order/645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">504</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reduced-rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">505</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">613</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pa_color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Black"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"shipping_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">506</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tax_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">507</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-TAX-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">508</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-STANDARD-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"fee_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"coupon_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-19T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-orders'>View List Of Orders</h2>
|
|
<p>This API helps you to view all the orders.</p>
|
|
<h3 id='http-request-3'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"orders"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"processing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"79.87"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"63.97"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_line_items_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.90"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_methods"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"payment_details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bacs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"paid"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"127.0.0.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordPress/4.1; http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"view_order_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/my-account/view-order/645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">504</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reduced-rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">505</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">613</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pa_color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Black"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"shipping_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">506</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tax_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">507</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-TAX-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">508</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-STANDARD-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"fee_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"coupon_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-19T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">644</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">644</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:33:42Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:33:42Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:33:42Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"on-hold"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"44.14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"30.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_line_items_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.15"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.65"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_methods"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"payment_details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bacs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"paid"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"127.0.0.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.91 Safari/537.36"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"view_order_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/my-account/view-order/644"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">499</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.20"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.20"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reduced-rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.45"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.45"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">96</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"shipping_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">501</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tax_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">502</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-TAX-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">503</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-STANDARD-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"fee_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"coupon_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-19T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Orders by status. eg: <code>processing</code> or <code>cancelled</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-an-order'>Update An Order</h2>
|
|
<p>This API lets you make changes to an order.</p>
|
|
<h3 id='http-request-4'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/orders/645 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"order": {
|
|
"status": "completed"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">status</span><span class="p">:</span> <span class="dl">'</span><span class="s1">completed</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"status"</span><span class="p">:</span> <span class="s">"completed"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"orders/645"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'status'</span> <span class="o">=></span> <span class="s1">'completed'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nf">update</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order: </span><span class="p">{</span>
|
|
<span class="ss">status: </span><span class="s2">"completed"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"orders/645"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_number"</span><span class="p">:</span><span class="w"> </span><span class="mi">645</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"79.87"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"63.97"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_line_items_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.90"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_methods"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"payment_details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bacs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"paid"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_ip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"127.0.0.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_user_agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordPress/4.1; http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"view_order_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/my-account/view-order/645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">504</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43.98"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reduced-rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">505</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">613</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pa_color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Black"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"shipping_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">506</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat Rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tax_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">507</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-TAX-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">508</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-STANDARD-1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"fee_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"coupon_lines"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"customer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-19T18:34:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"645"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_order_date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_spent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john.doe@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"(555) 555-5555"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_address"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"company"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"969 Market"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"address_2"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"94103"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='delete-an-order'>Delete An Order</h2>
|
|
<p>This API helps you delete an order.</p>
|
|
<h3 id='http-request-5'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/orders/645/?force<span class="o">=</span><span class="nb">true</span> <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/?force=true</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"orders/645/"</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="p">{</span><span class="s">"force"</span><span class="p">:</span> <span class="bp">True</span><span class="p">}).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="kc">true</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"orders/645/, force: true).parsed_response
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='parameters'>Parameters</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>force</code></td>
|
|
<td>string</td>
|
|
<td>Use <code>true</code> whether to permanently delete the order, defaults to <code>false</code>. Note that permanently deleting the order will return HTTP 200 rather than HTTP 202.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-orders-count'>View Orders Count</h2>
|
|
<p>This API lets you retrieve a count of all orders.</p>
|
|
<h3 id='http-request-6'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/count</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/count <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/count</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/count"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nf">get_count</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/count"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters-2'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Orders by status. eg: <code>processing</code> or <code>cancelled</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-list-of-order-statuses'>View List Of Order Statuses</h2>
|
|
<p>This API lets you retrieve a list of orders statuses available.</p>
|
|
<h3 id='http-request-7'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/statuses</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/statuses <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/statuses</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/statuses"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">orders</span><span class="o">-></span><span class="nf">get_statuses</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/statuses"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_statuses"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"pending"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending Payment"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"processing"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Processing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on-hold"</span><span class="p">:</span><span class="w"> </span><span class="s2">"On Hold"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Completed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cancelled"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cancelled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"refunded"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Refunded"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"failed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Failed"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='create-a-note-for-an-order'>Create A Note For An Order</h2>
|
|
<p>This API helps you to create a new note for an order.</p>
|
|
<h3 id='http-request-8'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/orders/<id>/notes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/orders/645/notes <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"order_note": {
|
|
"note": "Order ok!!!"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order_note</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">note</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Order ok!!!</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/notes</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order_note"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"note"</span><span class="p">:</span> <span class="s">"Order ok!!!"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"orders/645/notes"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'order_note'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'note'</span> <span class="o">=></span> <span class="s1">'Order ok!!!'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_notes</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order_note: </span><span class="p">{</span>
|
|
<span class="ss">note: </span><span class="s2">"Order ok!!!"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"orders/645/notes"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_note"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"416"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:56:44Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order ok!!!"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='order-notes-properties'>Order Notes Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Order note ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the order note was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>note</code></td>
|
|
<td>string</td>
|
|
<td>Order note <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_note</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows/define if the note is only for reference or for the customer (the user will be notified). Default is <code>false</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-an-order-note'>View An Order Note</h2>
|
|
<p>This API lets you retrieve and view a specific note from an order.</p>
|
|
<h3 id='http-request-9'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/<id>/notes/<note_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/645/notes/416 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/notes/416</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/645/notes/416"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_notes</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="mi">416</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/645/notes/416"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_note"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"416"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:56:44Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order ok!!!"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#order-notes-properties">Order Notes Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='view-list-of-notes-from-an-order'>View List Of Notes From An Order</h2>
|
|
<p>This API helps you to view all the notes from an order.</p>
|
|
<h3 id='http-request-10'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/<id>/notes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/645/notes <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/notes</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/645/notes"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_notes</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">645</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/645/notes"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_notes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"416"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:56:44Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order ok!!!"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"415"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:16:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order status changed from Processing to Completed."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"412"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:21Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order item stock reduced successfully."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"411"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:00:09Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order status changed from Pending Payment to Processing."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#order-notes-properties">Order Notes Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='update-an-order-note'>Update An Order Note</h2>
|
|
<p>This API lets you make changes to an order note.</p>
|
|
<h3 id='http-request-11'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/orders/<id>/notes/<note_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/orders/645/notes/416 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"order_note": {
|
|
"note": "Ok!"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order_note</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">note</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Ok!</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/notes/416</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order_note"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"note"</span><span class="p">:</span> <span class="s">"Ok!"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"orders/645/notes/416"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'order_note'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'note'</span> <span class="o">=></span> <span class="s1">'Ok!'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_notes</span><span class="o">-></span><span class="nf">update</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="mi">416</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order_note: </span><span class="p">{</span>
|
|
<span class="ss">note: </span><span class="s2">"Ok!"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"orders/645/notes/416"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_note"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"416"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T20:56:44Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"note"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ok!"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#order-notes-properties">Order Notes Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='delete-an-order-note'>Delete An Order Note</h2>
|
|
<p>This API helps you delete an order note.</p>
|
|
<h3 id='http-request-12'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/orders/<id>/notes/<note_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/orders/645/notes/416 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/notes/416</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"orders/645/notes/416"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_notes</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="mi">416</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"orders/645/notes/416"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted order note"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='create-a-refund-for-an-order'>Create A Refund For An Order</h2>
|
|
<p>This API helps you to create a new refund for an order.</p>
|
|
<h3 id='http-request-13'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/orders/<id>/refunds</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/orders/645/refunds <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"order_refund": {
|
|
"amount": 10
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order_refund</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="mi">10</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/refunds</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order_refund"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"amount"</span><span class="p">:</span> <span class="mi">10</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"orders/645/refunds"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'order_refund'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'amount'</span> <span class="o">=></span> <span class="mi">10</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_refunds</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order_refund: </span><span class="p">{</span>
|
|
<span class="ss">amount: </span><span class="mi">10</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"orders/645/refunds"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_refund"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">649</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:29:32Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='order-refunds-properties'>Order Refunds Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Order note ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the order refund was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>amount</code></td>
|
|
<td>string</td>
|
|
<td>Refund amount <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reason</code></td>
|
|
<td>string</td>
|
|
<td>Reason for refund</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>line_items</code></td>
|
|
<td>array</td>
|
|
<td>List of order items to refund. See <a href="line-items-properties">Line Items Properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-an-order-refund'>View An Order Refund</h2>
|
|
<p>This API lets you retrieve and view a specific refund from an order.</p>
|
|
<h3 id='http-request-14'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/<id>/refunds/<refund_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/645/refunds/649 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/refunds/649</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/645/refunds/649"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_refunds</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="mi">649</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/645/refunds/649"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_refund"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">649</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:29:32Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#order-refunds-properties">Order Refunds Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='view-list-of-refunds-from-an-order'>View List Of Refunds From An Order</h2>
|
|
<p>This API helps you to view all the refunds from an order.</p>
|
|
<h3 id='http-request-15'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/orders/<id>/refunds</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/orders/645/refunds <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/refunds</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"orders/645/refunds"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_refunds</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">645</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"orders/645/refunds"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_refunds"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">649</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:29:32Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">647</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:19:06Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">514</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reduced-rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">515</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">613</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#order-refunds-properties">Order Refunds Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='update-an-order-refund'>Update An Order Refund</h2>
|
|
<p>This API lets you make changes to an order refund.</p>
|
|
<h3 id='http-request-16'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/orders/<id>/refunds/<refund_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/orders/645/refunds/649 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"order_refund": {
|
|
"reason": "Because was it necessary!"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order_refund</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">reason</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Because was it necessary!</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/refunds/649</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order_refund"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"reason"</span><span class="p">:</span> <span class="s">"Because was it necessary!"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"orders/645/refunds/649"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'order_refund'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'reason'</span> <span class="o">=></span> <span class="s1">'Because was it necessary!'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_refunds</span><span class="o">-></span><span class="nf">update</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="mi">649</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order_refund: </span><span class="p">{</span>
|
|
<span class="ss">reason: </span><span class="s2">"Because was it necessary!"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"orders/645/refunds/649"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"order_refund"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">649</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-26T19:29:32Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Because was it necessary!"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"line_items"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#order-refunds-properties">Order Refunds Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='delete-an-order-refund'>Delete An Order Refund</h2>
|
|
<p>This API helps you delete an order refund.</p>
|
|
<h3 id='http-request-17'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/orders/<id>/refunds/<refund_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/orders/645/refunds/649 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">orders/645/refunds/649</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"orders/645/refunds/649"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">order_refunds</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">645</span><span class="p">,</span> <span class="mi">649</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"orders/645/refunds/649"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted refund"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h1 id='products'>Products</h1>
|
|
<p>This section lists all API that can be used to create, edit or otherwise manipulate products.</p>
|
|
<h2 id='products-properties'>Products Properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Product name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Product ID (post ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the product was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the product was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Product type. By default in WooCommerce the following types are available: <code>simple</code>, <code>grouped</code>, <code>external</code>, <code>variable</code>. Default is <code>simple</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Product status (post status). Default is <code>publish</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloadable</code></td>
|
|
<td>boolean</td>
|
|
<td>If the product is downloadable or not. Downloadable products give access to a file upon purchase</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>virtual</code></td>
|
|
<td>boolean</td>
|
|
<td>If the product is virtual or not. Virtual products are intangible and aren't shipped</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>permalink</code></td>
|
|
<td>string</td>
|
|
<td>Product URL (post permalink) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>SKU refers to a Stock-keeping unit, a unique identifier for each distinct product and service that can be purchased</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price</code></td>
|
|
<td>string</td>
|
|
<td>Current product price. This is setted from <code>regular_price</code> and <code>sale_price</code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>regular_price</code></td>
|
|
<td>string</td>
|
|
<td>Product regular price</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price</code></td>
|
|
<td>string</td>
|
|
<td>Product sale price</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price_dates_from</code></td>
|
|
<td>string</td>
|
|
<td>Sets the sale start date. Date in the <code>YYYY-MM-DD</code> format <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price_dates_to</code></td>
|
|
<td>string</td>
|
|
<td>Sets the sale end date. Date in the <code>YYYY-MM-DD</code> format <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price_html</code></td>
|
|
<td>string</td>
|
|
<td>Price formatted in HTML, e.g. <code><del><span class=\"amount\">&#36;&nbsp;3.00</span></del> <ins><span class=\"amount\">&#36;&nbsp;2.00</span></ins></code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxable</code></td>
|
|
<td>boolean</td>
|
|
<td>Show if the product is taxable or not <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status. The options are: <code>taxable</code>, <code>shipping</code> (Shipping only) and <code>none</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>managing_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Enable stock management at product level</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>stock_quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Stock quantity. If is a variable product this value will be used to control stock for all variations, unless you define stock at variation level.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>in_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Controls whether or not the product is listed as "in stock" or "out of stock" on the frontend.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backorders_allowed</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if backorders are allowed <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backordered</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if a product is on backorder (if the product have the stock_quantity negative) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backorders</code></td>
|
|
<td>mixed</td>
|
|
<td>If managing stock, this controls whether or not backorders are allowed. If enabled, stock quantity can go below 0. The options are: <code>false</code> (Do not allow), <code>notify</code> (Allow, but notify customer), and <code>true</code> (Allow) <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sold_individually</code></td>
|
|
<td>boolean</td>
|
|
<td>When <code>true</code> this only allow one item to be bought in a single order</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>purchaseable</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the product can be bought <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>featured</code></td>
|
|
<td>boolean</td>
|
|
<td>Featured Product</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>visible</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows whether or not the product is visible in the catalog <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>catalog_visibility</code></td>
|
|
<td>string</td>
|
|
<td>Catalog visibility. The following options are available: <code>visible</code> (Catalog and search), <code>catalog</code> (Only in catalog), <code>search</code> (Only in search) and <code>hidden</code> (Hidden from all). Default is <code>visible</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>on_sale</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the product is on sale or not <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>weight</code></td>
|
|
<td>string</td>
|
|
<td>Product weight in decimal format</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dimensions</code></td>
|
|
<td>array</td>
|
|
<td>List of the product dimensions. See <a href="#dimensions-properties">Dimensions Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_required</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the product need to be shipped or not <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_taxable</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows whether or not the product shipping is taxable <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Shipping class slug. Shipping classes are used by certain shipping methods to group similar products</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class_id</code></td>
|
|
<td>integer</td>
|
|
<td>Shipping class ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Product description</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enable_html_description</code></td>
|
|
<td>bool</td>
|
|
<td>Enable HTML for product description <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>short_description</code></td>
|
|
<td>string</td>
|
|
<td>Product short description</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enable_html_short_description</code></td>
|
|
<td>string</td>
|
|
<td>Enable HTML for product short description <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reviews_allowed</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows/define if reviews are allowed</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>average_rating</code></td>
|
|
<td>string</td>
|
|
<td>Reviews average rating <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rating_count</code></td>
|
|
<td>integer</td>
|
|
<td>Amount of reviews that the product have <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>related_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of related products IDs (<code>integer</code>) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>upsell_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of up-sell products IDs (<code>integer</code>). Up-sells are products which you recommend instead of the currently viewed product, for example, products that are more profitable or better quality or more expensive</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>cross_sell_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of cross-sell products IDs. Cross-sells are products which you promote in the cart, based on the current product</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_id</code></td>
|
|
<td>integer</td>
|
|
<td>Product parent ID (post_parent)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>categories</code></td>
|
|
<td>array</td>
|
|
<td>List of product categories names (<code>string</code>). In write-mode need to pass a array of categories IDs (<code>integer</code>) (<a href="http://codex.wordpress.org/Function_Reference/wp_set_object_terms">uses wp_set_object_terms()</a>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tags</code></td>
|
|
<td>array</td>
|
|
<td>List of product tags names (<code>string</code>). In write-mode need to pass a array of tags IDs (<code>integer</code>) (<a href="http://codex.wordpress.org/Function_Reference/wp_set_object_terms">uses wp_set_object_terms()</a>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>images</code></td>
|
|
<td>array</td>
|
|
<td>List of products images. See <a href="#images-properties">Images Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>featured_src</code></td>
|
|
<td>string</td>
|
|
<td>Featured image URL <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attributes</code></td>
|
|
<td>array</td>
|
|
<td>List of product attributes. See <a href="#attributes-properties">Attributes Properties</a>. Note: the attribute must be registered in WooCommerce before.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default_attributes</code></td>
|
|
<td>array</td>
|
|
<td>Defaults variation attributes. These are the attributes that will be pre-selected on the frontend. See <a href="#default-attributes-properties">Default Attributes Properties</a> <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads</code></td>
|
|
<td>array</td>
|
|
<td>List of downloadable files. See <a href="#downloads-properties">Downloads Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_limit</code></td>
|
|
<td>integer</td>
|
|
<td>Amount of times the product can be downloaded. In write-mode you can sent a blank string for unlimited re-downloads. e.g <code>''</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_expiry</code></td>
|
|
<td>integer</td>
|
|
<td>Number of days that the customer has up to be able to download the product. In write-mode you can sent a blank string for never expiry. e.g <code>''</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_type</code></td>
|
|
<td>string</td>
|
|
<td>Download type, this controls the <a href="http://schema.org/">schema</a>. The available options are: <code>''</code> (Standard Product), <code>application</code> (Application/Software) and <code>music</code> (Music)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>purchase_note</code></td>
|
|
<td>string</td>
|
|
<td>Optional note to send the customer after purchase.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_sales</code></td>
|
|
<td>integer</td>
|
|
<td>Amount of sales <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variations</code></td>
|
|
<td>array</td>
|
|
<td>List of products variations. See <a href="#variations-properties">Variations Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>array</td>
|
|
<td>List the product parent data when query for a variation <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_url</code></td>
|
|
<td>string</td>
|
|
<td>Product external URL. Only for <code>external</code> products <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>button_text</code></td>
|
|
<td>string</td>
|
|
<td>Product external button text. Only for <code>external</code> products <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='dimensions-properties'>Dimensions Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>length</code></td>
|
|
<td>string</td>
|
|
<td>Product length in decimal format</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>width</code></td>
|
|
<td>string</td>
|
|
<td>Product width in decimal format</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>height</code></td>
|
|
<td>string</td>
|
|
<td>Product height in decimal format</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>unit</code></td>
|
|
<td>string</td>
|
|
<td>Product name <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='images-properties'>Images Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Image ID (attachment ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the image was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the image was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>src</code></td>
|
|
<td>string</td>
|
|
<td>Image URL. In write-mode you can use to send new images</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Image title (attachment title) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>alt</code></td>
|
|
<td>string</td>
|
|
<td>Image alt text (attachment image alt text) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>position</code></td>
|
|
<td>integer</td>
|
|
<td>Image position. <code>0</code> means that the image is featured</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='attributes-properties'>Attributes Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Attribute slug</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>position</code></td>
|
|
<td>integer</td>
|
|
<td>Attribute position</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>visible</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows/define if the attribute is visible on the "Additional Information" tab in the product's page</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variation</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows/define if the attribute can be used as variation</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>options</code></td>
|
|
<td>array</td>
|
|
<td>List of available term names of the attribute</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='default-attributes-properties'>Default Attributes Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Attribute slug</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>option</code></td>
|
|
<td>string</td>
|
|
<td>Selected term name of the attribute</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='downloads-properties'>Downloads Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>string</td>
|
|
<td>File ID (File ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>File name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file</code></td>
|
|
<td>string</td>
|
|
<td>File URL. In write-mode you can use this property to send new files</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='variations-properties'>Variations Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Variation ID (post ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the variation was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the variation was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloadable</code></td>
|
|
<td>boolean</td>
|
|
<td>If the variation is downloadable or not. Downloadable variations give access to a file upon purchase</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>virtual</code></td>
|
|
<td>boolean</td>
|
|
<td>If the variation is virtual or not. Virtual variations are intangible and aren't shipped</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>permalink</code></td>
|
|
<td>string</td>
|
|
<td>Variation URL (post permalink) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>SKU refers to a Stock-keeping unit, a unique identifier for each distinct product and service that can be purchased</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price</code></td>
|
|
<td>string</td>
|
|
<td>Current variation price. This is setted from <code>regular_price</code> and <code>sale_price</code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>regular_price</code></td>
|
|
<td>string</td>
|
|
<td>Variation regular price</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price</code></td>
|
|
<td>string</td>
|
|
<td>Variation sale price</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price_dates_from</code></td>
|
|
<td>string</td>
|
|
<td>Sets the sale start date. Date in the <code>YYYY-MM-DD</code> format <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price_dates_to</code></td>
|
|
<td>string</td>
|
|
<td>Sets the sale end date. Date in the <code>YYYY-MM-DD</code> format <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxable</code></td>
|
|
<td>boolean</td>
|
|
<td>Show if the variation is taxable or not <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status. The options are: <code>taxable</code>, <code>shipping</code> (Shipping only) and <code>none</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>managing_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Enable stock management at variation level</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>stock_quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Stock quantity. If is a variable variation this value will be used to control stock for all variations, unless you define stock at variation level.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>in_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Controls whether or not the variation is listed as "in stock" or "out of stock" on the frontend.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backordered</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if a variation is on backorder (if the variation have the stock_quantity negative) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>purchaseable</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the variation can be bought <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>visible</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows whether or not the product parent is visible in the catalog <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>on_sale</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the variation is on sale or not <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>weight</code></td>
|
|
<td>string</td>
|
|
<td>Variation weight in decimal format</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dimensions</code></td>
|
|
<td>array</td>
|
|
<td>List of the variation dimensions. See <a href="#dimensions-properties">Dimensions Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Shipping class slug. Shipping classes are used by certain shipping methods to group similar products</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class_id</code></td>
|
|
<td>integer</td>
|
|
<td>Shipping class ID <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>image</code></td>
|
|
<td>array</td>
|
|
<td>Variation featured image. See <a href="#images-properties">Images Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attributes</code></td>
|
|
<td>array</td>
|
|
<td>List of variation attributes. Similar to a <code>simple</code> or <code>variable</code> product, but for <code>variation</code> indicate the attributes used to form the variation. See <a href="#attributes-properties">Attributes Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads</code></td>
|
|
<td>array</td>
|
|
<td>List of downloadable files. See <a href="#downloads-properties">Downloads Properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_limit</code></td>
|
|
<td>integer</td>
|
|
<td>Amount of times the variation can be downloaded. In write-mode you can sent a blank string for unlimited re-downloads. e.g <code>''</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_expiry</code></td>
|
|
<td>integer</td>
|
|
<td>Number of days that the customer has up to be able to download the varition. In write-mode you can sent a blank string for never expiry. e.g <code>''</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-product'>Create A Product</h2>
|
|
<p>This API helps you to create a new product.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/products</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of how to create a <code>simple</code> product:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/products <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"product": {
|
|
"title": "Premium Quality",
|
|
"type": "simple",
|
|
"regular_price": "21.99",
|
|
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
|
|
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
|
|
"categories": [
|
|
9,
|
|
14
|
|
],
|
|
"images": [
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg",
|
|
"position": 0
|
|
},
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg",
|
|
"position": 1
|
|
}
|
|
]
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">product</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">title</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Premium Quality</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">simple</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">'</span><span class="s1">21.99</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">short_description</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">categories</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">],</span>
|
|
<span class="na">images</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">products</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"product"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"title"</span><span class="p">:</span> <span class="s">"Premium Quality"</span><span class="p">,</span>
|
|
<span class="s">"type"</span><span class="p">:</span> <span class="s">"simple"</span><span class="p">,</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"21.99"</span><span class="p">,</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo."</span><span class="p">,</span>
|
|
<span class="s">"short_description"</span><span class="p">:</span> <span class="s">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas."</span><span class="p">,</span>
|
|
<span class="s">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"images"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"products"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'product'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'title'</span> <span class="o">=></span> <span class="s1">'Premium Quality'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'simple'</span><span class="p">,</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'21.99'</span><span class="p">,</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.'</span><span class="p">,</span>
|
|
<span class="s1">'short_description'</span> <span class="o">=></span> <span class="s1">'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.'</span><span class="p">,</span>
|
|
<span class="s1">'categories'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'images'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http =>//example.com/wp-content/uploads/2015/01/premium-quality-front.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">0</span>
|
|
<span class="p">),</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http =>//example.com/wp-content/uploads/2015/01/premium-quality-back.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">1</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">product: </span><span class="p">{</span>
|
|
<span class="ss">title: </span><span class="s2">"Premium Quality"</span><span class="p">,</span>
|
|
<span class="ss">type: </span><span class="s2">"simple"</span><span class="p">,</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"21.99"</span><span class="p">,</span>
|
|
<span class="ss">description: </span><span class="s2">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo."</span><span class="p">,</span>
|
|
<span class="ss">short_description: </span><span class="s2">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas."</span><span class="p">,</span>
|
|
<span class="ss">categories: </span><span class="p">[</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">images: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">0</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">1</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"products"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"publish"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/premium-quality/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">amount</span><span class="se">\"</span><span class="s2">>&#36;&nbsp;21.99</span>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backorders_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sold_individually"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"catalog_visibility"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviews_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"related_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">19</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"T-shirts"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"images"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">547</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">548</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"featured_src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchase_note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variations"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p>Example of how to create a <code>variable</code> product:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/products <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"product": {
|
|
"title": "Ship Your Idea",
|
|
"type": "variable",
|
|
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
|
|
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
|
|
"categories": [
|
|
9,
|
|
14
|
|
],
|
|
"images": [
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg",
|
|
"position": 0
|
|
},
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg",
|
|
"position": 1
|
|
},
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg",
|
|
"position": 2
|
|
},
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg",
|
|
"position": 3
|
|
}
|
|
],
|
|
"attributes": [
|
|
{
|
|
"name": "Color",
|
|
"slug": "color",
|
|
"position": "0",
|
|
"visible": false,
|
|
"variation": true,
|
|
"options": [
|
|
"Black",
|
|
"Green"
|
|
]
|
|
}
|
|
],
|
|
"default_attributes": [
|
|
{
|
|
"name": "Color",
|
|
"slug": "color",
|
|
"option": "Black"
|
|
}
|
|
],
|
|
"variations": [
|
|
{
|
|
"regular_price": "19.99",
|
|
"image": [
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg",
|
|
"position": 0
|
|
}
|
|
],
|
|
"attributes": [
|
|
{
|
|
"name": "Color",
|
|
"slug": "color",
|
|
"option": "black"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"regular_price": "19.99",
|
|
"image": [
|
|
{
|
|
"src": "http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg",
|
|
"position": 0
|
|
}
|
|
],
|
|
"attributes": [
|
|
{
|
|
"name": "Color",
|
|
"slug": "color",
|
|
"option": "green"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">product</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">title</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Ship Your Idea</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">variable</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">short_description</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">categories</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">],</span>
|
|
<span class="na">images</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">3</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">attributes</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">slug</span><span class="p">:</span> <span class="dl">'</span><span class="s1">color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="dl">'</span><span class="s1">0</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">visible</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">variation</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">options</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="dl">'</span><span class="s1">Black</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="dl">'</span><span class="s1">Green</span><span class="dl">'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">default_attributes</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">slug</span><span class="p">:</span> <span class="dl">'</span><span class="s1">color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Black</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">variations</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">'</span><span class="s1">19.99</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">image</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">attributes</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">slug</span><span class="p">:</span> <span class="dl">'</span><span class="s1">color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">'</span><span class="s1">black</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">'</span><span class="s1">19.99</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">image</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">position</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">attributes</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">Color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">slug</span><span class="p">:</span> <span class="dl">'</span><span class="s1">color</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">'</span><span class="s1">green</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">products</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"product"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"title"</span><span class="p">:</span> <span class="s">"Ship Your Idea"</span><span class="p">,</span>
|
|
<span class="s">"type"</span><span class="p">:</span> <span class="s">"variable"</span><span class="p">,</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo."</span><span class="p">,</span>
|
|
<span class="s">"short_description"</span><span class="p">:</span> <span class="s">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas."</span><span class="p">,</span>
|
|
<span class="s">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"images"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">3</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"attributes"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Color"</span><span class="p">,</span>
|
|
<span class="s">"slug"</span><span class="p">:</span> <span class="s">"color"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
|
|
<span class="s">"visible"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"variation"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"options"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="s">"Black"</span><span class="p">,</span>
|
|
<span class="s">"Green"</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"default_attributes"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Color"</span><span class="p">,</span>
|
|
<span class="s">"slug"</span><span class="p">:</span> <span class="s">"color"</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"Black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"variations"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"19.99"</span><span class="p">,</span>
|
|
<span class="s">"image"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"attributes"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Color"</span><span class="p">,</span>
|
|
<span class="s">"slug"</span><span class="p">:</span> <span class="s">"color"</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"19.99"</span><span class="p">,</span>
|
|
<span class="s">"image"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span>
|
|
<span class="s">"position"</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"attributes"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Color"</span><span class="p">,</span>
|
|
<span class="s">"slug"</span><span class="p">:</span> <span class="s">"color"</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"green"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"products"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'product'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'title'</span> <span class="o">=></span> <span class="s1">'Ship Your Idea'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'variable'</span><span class="p">,</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.'</span><span class="p">,</span>
|
|
<span class="s1">'short_description'</span> <span class="o">=></span> <span class="s1">'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.'</span><span class="p">,</span>
|
|
<span class="s1">'categories'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'images'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">0</span>
|
|
<span class="p">),</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">1</span>
|
|
<span class="p">),</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">2</span>
|
|
<span class="p">),</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">3</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'attributes'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Color'</span><span class="p">,</span>
|
|
<span class="s1">'slug'</span> <span class="o">=></span> <span class="s1">'color'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="s1">'0'</span><span class="p">,</span>
|
|
<span class="s1">'visible'</span> <span class="o">=></span> <span class="kc">False</span><span class="p">,</span>
|
|
<span class="s1">'variation'</span> <span class="o">=></span> <span class="kc">True</span><span class="p">,</span>
|
|
<span class="s1">'options'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'Black'</span><span class="p">,</span>
|
|
<span class="s1">'Green'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'default_attributes'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Color'</span><span class="p">,</span>
|
|
<span class="s1">'slug'</span> <span class="o">=></span> <span class="s1">'color'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'Black'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'variations'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'19.99'</span><span class="p">,</span>
|
|
<span class="s1">'image'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">0</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'attributes'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Color'</span><span class="p">,</span>
|
|
<span class="s1">'slug'</span> <span class="o">=></span> <span class="s1">'color'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'black'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'19.99'</span><span class="p">,</span>
|
|
<span class="s1">'image'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg'</span><span class="p">,</span>
|
|
<span class="s1">'position'</span> <span class="o">=></span> <span class="mi">0</span>
|
|
<span class="p">)</span>
|
|
<span class="p">),</span>
|
|
<span class="s1">'attributes'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Color'</span><span class="p">,</span>
|
|
<span class="s1">'slug'</span> <span class="o">=></span> <span class="s1">'color'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'green'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">product: </span><span class="p">{</span>
|
|
<span class="ss">title: </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span>
|
|
<span class="ss">type: </span><span class="s2">"variable"</span><span class="p">,</span>
|
|
<span class="ss">description: </span><span class="s2">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo."</span><span class="p">,</span>
|
|
<span class="ss">short_description: </span><span class="s2">"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas."</span><span class="p">,</span>
|
|
<span class="ss">categories: </span><span class="p">[</span>
|
|
<span class="mi">9</span><span class="p">,</span>
|
|
<span class="mi">14</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">images: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">0</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">3</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">attributes: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Color"</span><span class="p">,</span>
|
|
<span class="ss">slug: </span><span class="s2">"color"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="s2">"0"</span><span class="p">,</span>
|
|
<span class="ss">visible: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">variation: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">options: </span><span class="p">[</span>
|
|
<span class="s2">"Black"</span><span class="p">,</span>
|
|
<span class="s2">"Green"</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">default_attributes: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Color"</span><span class="p">,</span>
|
|
<span class="ss">slug: </span><span class="s2">"color"</span><span class="p">,</span>
|
|
<span class="ss">option: </span><span class="s2">"Black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">variations: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"19.99"</span><span class="p">,</span>
|
|
<span class="ss">image: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">attributes: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Color"</span><span class="p">,</span>
|
|
<span class="ss">slug: </span><span class="s2">"color"</span><span class="p">,</span>
|
|
<span class="ss">option: </span><span class="s2">"black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"19.99"</span><span class="p">,</span>
|
|
<span class="ss">image: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">attributes: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Color"</span><span class="p">,</span>
|
|
<span class="ss">slug: </span><span class="s2">"color"</span><span class="p">,</span>
|
|
<span class="ss">option: </span><span class="s2">"green"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"products"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">604</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"variable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"publish"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/product/ship-your-idea/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">amount</span><span class="se">\"</span><span class="s2">>&#36;&nbsp;19.99</span>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backorders_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sold_individually"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"catalog_visibility"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviews_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"related_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="mi">40</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">577</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">34</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"T-shirts"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"images"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">605</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">606</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">607</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">608</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"featured_src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"Green"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchase_note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">609</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/product/ship-your-idea-10/?attribute_pa_color=black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">610</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:18Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:18Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"option"</span><span class="p">:</span><span class="w"> </span><span class="s2">"black"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">611</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/product/ship-your-idea-10/?attribute_pa_color=green"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">612</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"option"</span><span class="p">:</span><span class="w"> </span><span class="s2">"green"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-a-product'>View A Product</h2>
|
|
<p>This API lets you retrieve and view a specific product by ID or sku.</p>
|
|
<h3 id='http-request-2'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/products/sku/<sku></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/products/546 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/546</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"products/546"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">546</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"products/546"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"publish"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/premium-quality/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">amount</span><span class="se">\"</span><span class="s2">>&#36;&nbsp;21.99</span>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backorders_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sold_individually"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"catalog_visibility"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviews_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"related_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">19</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"T-shirts"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"images"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">547</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">548</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"featured_src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchase_note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variations"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-products'>View List Of Products</h2>
|
|
<p>This API helps you to view all the products.</p>
|
|
<h3 id='http-request-3'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/products</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/products <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">products</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"products"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"products"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"products"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"publish"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/premium-quality/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">amount</span><span class="se">\"</span><span class="s2">>&#36;&nbsp;21.99</span>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backorders_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sold_individually"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"catalog_visibility"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviews_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"related_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">19</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"T-shirts"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"images"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">547</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">548</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"featured_src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchase_note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variations"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship Your Idea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">604</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"variable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"publish"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/product/ship-your-idea/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">amount</span><span class="se">\"</span><span class="s2">>&#36;&nbsp;19.99</span>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backorders_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sold_individually"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"catalog_visibility"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviews_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"related_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="mi">40</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">577</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">34</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"T-shirts"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"images"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">605</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">606</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">607</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:15Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">608</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-green-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"featured_src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"Green"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchase_note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">609</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/product/ship-your-idea-10/?attribute_pa_color=black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">610</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:18Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:18Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-black-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"option"</span><span class="p">:</span><span class="w"> </span><span class="s2">"black"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">611</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:14Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/product/ship-your-idea-10/?attribute_pa_color=green"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19.99"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">612</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T20:37:19Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example/wp-content/uploads/2015/01/ship-your-idea-green-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"option"</span><span class="p">:</span><span class="w"> </span><span class="s2">"green"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Products by type. eg: <code>simple</code> or <code>variable</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>category</code></td>
|
|
<td>string</td>
|
|
<td>Products by category.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Filter a product by SKU.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-product'>Update A Product</h2>
|
|
<p>This API lets you make changes to a product.</p>
|
|
<h3 id='http-request-4'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/products/546 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"product": {
|
|
"regular_price": "24.54"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">product</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">'</span><span class="s1">24.54</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/546</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"product"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"24.54"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"products/546"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'product'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'regular_price'</span><span class="o">:</span> <span class="s1">'24.54'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">update</span><span class="p">(</span><span class="mi">546</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">product: </span><span class="p">{</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"24.54"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"products/546"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">546</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:55:31Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"publish"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/premium-quality/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"24.54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"regular_price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"24.54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">amount</span><span class="se">\"</span><span class="s2">>&#36;&nbsp;24.54</span>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"managing_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"stock_quantity"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"in_stock"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backorders_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"backordered"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sold_individually"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchaseable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"catalog_visibility"</span><span class="p">:</span><span class="w"> </span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"on_sale"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"dimensions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"width"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"height"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cm"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_taxable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_class_id"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviews_allowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"related_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">19</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"T-shirts"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"images"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">547</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:16Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">548</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-22T19:46:17Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-back.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"featured_src"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/2015/01/premium-quality-front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"download_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_expiry"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"download_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"purchase_note"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variations"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='delete-a-product'>Delete A Product</h2>
|
|
<p>This API helps you delete a product.</p>
|
|
<h3 id='http-request-5'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/products/546/?force<span class="o">=</span><span class="nb">true</span> <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/546/?force=true</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"products/546/"</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="p">{</span><span class="s">"force"</span><span class="p">:</span> <span class="bp">True</span><span class="p">}).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">546</span><span class="p">,</span> <span class="kc">true</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"products/546, force: true).parsed_response
|
|
</span></code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted product"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='parameters'>Parameters</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>force</code></td>
|
|
<td>string</td>
|
|
<td>Use <code>true</code> whether to permanently delete the product, defaults to <code>false</code>. Note that permanently deleting the product will return HTTP 200 rather than HTTP 202.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-products-count'>View Products Count</h2>
|
|
<p>This API lets you retrieve a count of all products.</p>
|
|
<h3 id='http-request-6'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/products/count</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/products/count <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/count</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"products/count"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">get_count</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"products/count"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters-2'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Products by type. eg: <code>simple</code> or <code>variable</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>category</code></td>
|
|
<td>string</td>
|
|
<td>Products by category.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-list-of-product-reviews'>View List Of Product Reviews</h2>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/products/<id>/reviews</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/products/546/reviews <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/546/reviews</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"products/546/reviews"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">get_reviews</span><span class="p">(</span><span class="mi">546</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"products/546/reviews"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product_reviews"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-06-07T11:57:45Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"review"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This t-shirt is awesome! Would recommend to everyone!</span><span class="se">\n\n</span><span class="s2">I'm ordering mine next week"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviewer_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Andrew"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviewer_email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"andrew@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"verified"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-06-07T11:53:49Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"review"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wonderful quality, and an awesome design. WooThemes ftw!"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviewer_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cobus Bester"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"reviewer_email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cobus@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"verified"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='product-reviews-properties'>Product Reviews Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Review ID (comment ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the review was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rating</code></td>
|
|
<td>string</td>
|
|
<td>Review rating (0 to 5) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reviewer_name</code></td>
|
|
<td>string</td>
|
|
<td>Reviewer name <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reviewer_email</code></td>
|
|
<td>string</td>
|
|
<td>Reviewer email <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>verified</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the reviewer bought the product or not <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-a-product-category'>View A Product Category</h2>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/products/categories/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/products/categories/9 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/categories/9</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"products/categories/9"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">get_categories</span><span class="p">(</span><span class="mi">9</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"products/categories/9"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product_category"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h3 id='product-category-properties'>Product Category Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Category ID (term ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Category Name <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Category slug <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>integer</td>
|
|
<td>Category parent <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Category description <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>display</code></td>
|
|
<td>string</td>
|
|
<td>Category archive display type, the types available include: <code>default</code>, <code>products</code>, <code>subcategories</code> and <code>both</code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>image</code></td>
|
|
<td>string</td>
|
|
<td>Category image URL <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>count</code></td>
|
|
<td>integer</td>
|
|
<td>Shows the quantity of products in this category <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-list-of-product-categories'>View List Of Product Categories</h2>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v3/products/categories</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v3/products/categories <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">products/categories</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"products/categories"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">products</span><span class="o">-></span><span class="nf">get_categories</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"products/categories"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"product_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">15</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Albums"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"albums"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">11</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"clothing"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hoodies"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hoodies"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">11</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Music"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"music"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Posters"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"posters"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Singles"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"singles"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">11</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">14</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"T-shirts"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"t-shirts"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">17</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#product-category-properties">Product Category Properties</a> for more details on this response.
|
|
</aside>
|
|
<h1 id='reports'>Reports</h1>
|
|
<p>This section lists all API that can be used view reports.</p>
|
|
<h2 id='reports-filters'>Reports Filters</h2>
|
|
<p>Use the following filters for any type of report to specify the period of sales: </p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>period</code></td>
|
|
<td>string</td>
|
|
<td>The supported periods are: <code>week</code>, <code>month</code>, <code>last_month</code>, and <code>year</code>. If you use an invalid period, <code>week</code> is used. If you don't specify a period, the current day is used</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_min</code></td>
|
|
<td>string</td>
|
|
<td>Return sales for a specific start date. The date need to be in the <code>YYYY-MM-DD</code> format</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_max</code></td>
|
|
<td>string</td>
|
|
<td>Return sales for a specific end date. The dates need to be in the <code>YYYY-MM-DD</code> format. Required to set the <code>filter[date_min]</code> too</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-list-of-reports'>View List Of Reports</h2>
|
|
<p>This API lets you retrieve and view a simple list of available reports.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/reports</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/reports <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">reports</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"reports"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">reports</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"reports"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"reports"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"sales"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"sales/top_sellers"</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-sales-report'>View List Of Sales Report</h2>
|
|
<p>This API lets you retrieve and view a list of sales report.</p>
|
|
<h3 id='http-request-2'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/reports/sales</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/reports/sales?filter[date_min]<span class="o">=</span>2015-01-18&filter[date_max]<span class="o">=</span>2015-01-21 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">reports/sales?filter[date_min]=2015-01-18&filter[date_max]=2015-01-21</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"reports/sales?filter[date_min]=2015-01-18&filter[date_max]=2015-01-21"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$args</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'filter'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'date_min'</span> <span class="o">=></span> <span class="s1">'2015-01-18'</span><span class="p">,</span>
|
|
<span class="s1">'date_max'</span> <span class="o">=></span> <span class="s1">'2015-01-21'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">reports</span><span class="o">-></span><span class="nf">get_sales</span><span class="p">(</span><span class="nv">$args</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"reports/sales?filter[date_min]=2015-01-18&filter[date_max]=2015-01-21"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"sales"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"580.10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"average_sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"145.03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_orders"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_items"</span><span class="p">:</span><span class="w"> </span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"26.10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"totals_grouped_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"day"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"totals"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"2015-01-18"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-17.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"2015-01-19"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"2015-01-20"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"2015-01-21"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"597.10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"orders"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"26.10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"total_customers"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-top-sellers-report'>View List Of Top Sellers Report</h2>
|
|
<p>This API lets you retrieve and view a list of top sellers report.</p>
|
|
<h3 id='http-request-3'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/reports/sales/top_sellers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/reports/sales/top_sellers?filter[period]<span class="o">=</span>last_month <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">reports/sales/top_sellers?filter[period]=last_month</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"reports/sales/top_sellers?filter[period]=last_month"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$args</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'filter'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'period'</span> <span class="o">=></span> <span class="s1">'last_month'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">reports</span><span class="o">-></span><span class="nf">get_top_sellers</span><span class="p">(</span><span class="nv">$args</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"reports/sales/top_sellers?filter[period]=last_month"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"top_sellers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Happy Ninja"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"37"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"24"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flying Ninja"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"70"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"14"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Happy Ninja"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"53"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ninja Silhouette"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"31"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Logo"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"15"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"83"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Premium Quality"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"19"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ninja Silhouette"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"quantity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h1 id='webhooks'>Webhooks</h1>
|
|
<p>This section lists all API that can be used to create, edit or otherwise manipulate webhooks.</p>
|
|
<h2 id='webhooks-properties'>Webhooks Properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>The webhook ID (post ID) <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>A friendly name for the webhook, defaults to "Webhook created on <date>"</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Webhook status, options are <code>active</code> (delivers payload), <code>paused</code> (does not deliver), or <code>disabled</code> (does not deliver due delivery failures). Default is <code>active</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>topic</code></td>
|
|
<td>string</td>
|
|
<td>Webhook topic, e.g. <code>coupon.updated</code>. <a href="#topics">See the complete list</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>resource</code></td>
|
|
<td>string</td>
|
|
<td>Webhook resource, e.g. <code>coupon</code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>event</code></td>
|
|
<td>string</td>
|
|
<td>Webhook event, e.g. <code>updated</code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hooks</code></td>
|
|
<td>array</td>
|
|
<td>WooCommerce action names associated with the webhook <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>delivery_url</code></td>
|
|
<td>string</td>
|
|
<td>The URL where the webhook payload is delivered</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>secret</code></td>
|
|
<td>string</td>
|
|
<td>Secret key used to generate a hash of the delivered webhook and provided in the request headers. <i class="label label-info">required</i> <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the webhook was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updated_at</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the webhook was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='delivery-properties'>Delivery Properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>The delivery ID (comment ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>duration</code></td>
|
|
<td>string</td>
|
|
<td>The delivery duration, in seconds</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>summary</code></td>
|
|
<td>string</td>
|
|
<td>A friendly summary of the response including the HTTP response code, message, and body</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>request_url</code></td>
|
|
<td>string</td>
|
|
<td>The URL where the webhook was delivered</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>request_headers</code></td>
|
|
<td>array</td>
|
|
<td>Array of request headers (see <a href="#request-headers-properties">Request Headers Attributes</a>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>request_body</code></td>
|
|
<td>string</td>
|
|
<td>The request body, this matches the API response for the given resource (e.g. for the coupon.updated topic, the request body would match the response for GET /coupons/{id})</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_code</code></td>
|
|
<td>string</td>
|
|
<td>The HTTP response code from the receiving server</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_message</code></td>
|
|
<td>string</td>
|
|
<td>The HTTP response message from the receiving server</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_headers</code></td>
|
|
<td>array</td>
|
|
<td>Array of the response headers from the receiving server</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_body</code></td>
|
|
<td>string</td>
|
|
<td>The response body from the receiving server</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_at</code></td>
|
|
<td>string</td>
|
|
<td>A DateTime of when the delivery was logged</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='request-headers-properties'>Request Headers Properties</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>User-Agent</code></td>
|
|
<td>string</td>
|
|
<td>The request user agent, defaults to "WooCommerce/{version} Hookshot (WordPress/{version})"</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Content-Type</code></td>
|
|
<td>string</td>
|
|
<td>The request content-type, defaults to "application/json"</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Topic</code></td>
|
|
<td>string</td>
|
|
<td>The webhook topic</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Resource</code></td>
|
|
<td>string</td>
|
|
<td>The webhook resource</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Event</code></td>
|
|
<td>string</td>
|
|
<td>The webhook event</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Signature</code></td>
|
|
<td>string</td>
|
|
<td>A base64 encoded HMAC-SHA256 hash of the payload</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-ID</code></td>
|
|
<td>integer</td>
|
|
<td>The webhook's ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Delivery-ID</code></td>
|
|
<td>integer</td>
|
|
<td>The delivery ID</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-webhook'>Create A Webhook</h2>
|
|
<p>This API helps you to create a new webhook.</p>
|
|
<h3 id='http-request'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wc-api/v2/webhooks</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wc-api/v2/webhooks <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"webhook": {
|
|
"name": "An add to cart webhook",
|
|
"secret": "my-super-secret-private-key",
|
|
"topic": "action.woocommerce_add_to_cart",
|
|
"delivery_url": "http://requestb.in/1exdwip1"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">webhook</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">'</span><span class="s1">An add to cart webhook</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">secret</span><span class="p">:</span> <span class="dl">'</span><span class="s1">my-super-secret-private-key</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">topic</span><span class="p">:</span> <span class="dl">'</span><span class="s1">action.woocommerce_add_to_cart</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">delivery_url</span><span class="p">:</span> <span class="dl">'</span><span class="s1">http://requestb.in/1exdwip1</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"webhook"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"An add to cart webhook"</span><span class="p">,</span>
|
|
<span class="s">"secret"</span><span class="p">:</span> <span class="s">"my-super-secret-private-key"</span><span class="p">,</span>
|
|
<span class="s">"topic"</span><span class="p">:</span> <span class="s">"action.woocommerce_add_to_cart"</span><span class="p">,</span>
|
|
<span class="s">"delivery_url"</span><span class="p">:</span> <span class="s">"http://requestb.in/1exdwip1"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">"webhooks"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'webhook'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'An add to cart webhook'</span><span class="p">,</span>
|
|
<span class="s1">'secret'</span> <span class="o">=></span> <span class="s1">'my-super-secret-private-key'</span><span class="p">,</span>
|
|
<span class="s1">'topic'</span> <span class="o">=></span> <span class="s1">'action.woocommerce_add_to_cart'</span><span class="p">,</span>
|
|
<span class="s1">'delivery_url'</span> <span class="o">=></span> <span class="s1">'http://requestb.in/1exdwip1'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">create</span><span class="p">(</span><span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">webhook: </span><span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"An add to cart webhook"</span><span class="p">,</span>
|
|
<span class="ss">secret: </span><span class="s2">"my-super-secret-private-key"</span><span class="p">,</span>
|
|
<span class="ss">topic: </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span>
|
|
<span class="ss">delivery_url: </span><span class="s2">"http://requestb.in/1exdwip1"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">post</span><span class="p">(</span><span class="s2">"webhooks"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"webhook"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An add to cart webhook"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"hooks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"woocommerce_add_to_cart"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"delivery_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/1exdwip1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-a-webhook'>View A Webhook</h2>
|
|
<p>This API lets you retrieve and view a specific webhook.</p>
|
|
<h3 id='http-request-2'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/webhooks/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/webhooks/535 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks/535</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"webhooks/535"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="mi">535</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"webhooks/535"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"webhook"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An add to cart webhook"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"hooks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"woocommerce_add_to_cart"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"delivery_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/1exdwip1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-list-of-webhooks'>View List Of Webhooks</h2>
|
|
<p>This API helps you to view all the webhooks.</p>
|
|
<h3 id='http-request-3'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/webhooks</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/webhooks <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"webhooks"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">get</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"webhooks"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"webhooks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An add to cart webhook"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"hooks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"woocommerce_add_to_cart"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"delivery_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/1exdwip1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">313</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Webhook created on Jan 17, 2015 @ 11:45 AM"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"order.created"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"created"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"hooks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"woocommerce_checkout_order_processed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_process_shop_order_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_create_order"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"delivery_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/1exdwip1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-12-17T11:45:05Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-10T00:41:08Z"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Webhooks by status. The following options are available: <code>active</code> or <code>paused</code> and <code>disabled</code>. Default is <code>active</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-webhook'>Update A Webhook</h2>
|
|
<p>This API lets you make changes to a webhook.</p>
|
|
<h3 id='http-request-4'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wc-api/v2/webhook/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wc-api/v2/webhook/535 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"webhook": {
|
|
"status": "paused"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">webhook</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">status</span><span class="p">:</span> <span class="dl">'</span><span class="s1">paused</span><span class="dl">'</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks/535</span><span class="dl">'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"webhook"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"status"</span><span class="p">:</span> <span class="s">"paused"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="s">"webhooks/535"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span>
|
|
<span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'webhook'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span>
|
|
<span class="s1">'status'</span> <span class="o">=></span> <span class="s1">'paused'</span>
|
|
<span class="p">)</span>
|
|
<span class="p">);</span>
|
|
|
|
<span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">updaste</span><span class="p">(</span><span class="mi">535</span><span class="p">,</span> <span class="nv">$data</span><span class="p">));</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">webhook: </span><span class="p">{</span>
|
|
<span class="ss">status: </span><span class="s2">"paused"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">put</span><span class="p">(</span><span class="s2">"webhooks/535"</span><span class="p">,</span> <span class="n">data</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"webhook"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An add to cart webhook"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"paused"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"hooks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"woocommerce_add_to_cart"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"delivery_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/1exdwip1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T13:19:58Z"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='delete-a-webhook'>Delete A Webhook</h2>
|
|
<p>This API helps you delete a webhook.</p>
|
|
<h3 id='http-request-5'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wc-api/v2/webhooks/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wc-api/v2/webhooks/535 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks/535</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">delete</span><span class="p">(</span><span class="s">"webhooks/535"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nb">delete</span><span class="p">(</span><span class="mi">535</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="s2">"webhooks/535"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permanently deleted webhook"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h2 id='view-webhooks-count'>View Webhooks Count</h2>
|
|
<p>This API lets you retrieve a count of all webhooks.</p>
|
|
<h3 id='http-request-6'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/webhooks/count</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/webhooks/count <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks/count</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"webhooks/count"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">get_count</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"webhooks/count"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-filters-2'>Available Filters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Filter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Webhooks by status. The following options are available: <code>active</code> or <code>paused</code> and <code>disabled</code></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='view-a-webhooks-delivery'>View A Webhooks Delivery</h2>
|
|
<p>This API lets you retrieve and view a specific webhook delivery.</p>
|
|
<h3 id='http-request-7'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/webhooks/<id>/deliveries/<delivery_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/webhooks/535/deliveries/378 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks/535/deliveries/378</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"webhooks/535/deliveries/378"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">get_deliveries</span><span class="p">(</span><span class="mi">378</span><span class="p">));</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"webhooks/535/deliveries/378"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"webhook_delivery"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">378</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"duration"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.90226"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"summary"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTTP 200 OK: ok"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/125q7ns1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"User-Agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WooCommerce/2.3.0 Hookshot (WordPress/4.1)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"Content-Type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/json"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Signature"</span><span class="p">:</span><span class="w"> </span><span class="s2">"geC1akFhCtsO7fbXz5XiGUsMsRa4Mt0IJsZ96nTaHjI="</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-ID"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Delivery-ID"</span><span class="p">:</span><span class="w"> </span><span class="mi">378</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"request_body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{</span><span class="se">\"</span><span class="s2">action</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">woocommerce_add_to_cart</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">arg</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">7cbbc409ec990f19c78c75bd1e06f215</span><span class="se">\"</span><span class="s2">}"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"200"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"connection"</span><span class="p">:</span><span class="w"> </span><span class="s2">"close"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"server"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gunicorn/18.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wed, 21 Jan 2015 16:22:49 GMT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"content-type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"text/html; charset=utf-8"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"content-length"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sponsored-by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://www.runscope.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.1 vegur"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"response_body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ok"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T16:26:12Z"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
<aside class="notice">
|
|
View the <a href="#delivery-properties">Delivery Properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='view-list-of-webhooks-deliveries'>View List Of Webhooks Deliveries</h2>
|
|
<p>This API helps you to view all deliveries from a specific webhooks.</p>
|
|
<h3 id='http-request-8'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wc-api/v2/webhooks/<id>/deliveries</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wc-api/v2/webhooks/535/deliveries <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">'</span><span class="s1">webhooks/535/deliveries</span><span class="dl">'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="k">print</span><span class="p">(</span><span class="n">wcapi</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s">"webhooks/535/deliveries"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight php tab-php"><code><span class="cp"><?php</span> <span class="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="n">webhooks</span><span class="o">-></span><span class="nf">get_deliveries</span><span class="p">());</span> <span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"webhooks/535/deliveries"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>JSON response example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"webhook_deliveries"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">380</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"duration"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.58635"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"summary"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTTP 200 OK: ok"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/125q7ns1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"User-Agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WooCommerce/2.3.0 Hookshot (WordPress/4.1)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"Content-Type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/json"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Signature"</span><span class="p">:</span><span class="w"> </span><span class="s2">"st4egVCTwG1JMfxmxe7MZYEuj9Y6Euge4SOTNfCUCWY="</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-ID"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Delivery-ID"</span><span class="p">:</span><span class="w"> </span><span class="mi">380</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"request_body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{</span><span class="se">\"</span><span class="s2">action</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">woocommerce_add_to_cart</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">arg</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">c16a5320fa475530d9583c34fd356ef5</span><span class="se">\"</span><span class="s2">}"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"200"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"connection"</span><span class="p">:</span><span class="w"> </span><span class="s2">"close"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"server"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gunicorn/18.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wed, 21 Jan 2015 16:23:05 GMT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"content-type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"text/html; charset=utf-8"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"content-length"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sponsored-by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://www.runscope.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.1 vegur"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"response_body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ok"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T16:26:28Z"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">378</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"duration"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.90226"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"summary"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTTP 200 OK: ok"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_method"</span><span class="p">:</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://requestb.in/125q7ns1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"request_headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"User-Agent"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WooCommerce/2.3.0 Hookshot (WordPress/4.1)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"Content-Type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"application/json"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action.woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce_add_to_cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Signature"</span><span class="p">:</span><span class="w"> </span><span class="s2">"geC1akFhCtsO7fbXz5XiGUsMsRa4Mt0IJsZ96nTaHjI="</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-ID"</span><span class="p">:</span><span class="w"> </span><span class="mi">535</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"X-WC-Webhook-Delivery-ID"</span><span class="p">:</span><span class="w"> </span><span class="mi">378</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"request_body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{</span><span class="se">\"</span><span class="s2">action</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">woocommerce_add_to_cart</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">arg</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">7cbbc409ec990f19c78c75bd1e06f215</span><span class="se">\"</span><span class="s2">}"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"200"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"response_headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"connection"</span><span class="p">:</span><span class="w"> </span><span class="s2">"close"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"server"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gunicorn/18.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wed, 21 Jan 2015 16:22:49 GMT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"content-type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"text/html; charset=utf-8"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"content-length"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sponsored-by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://www.runscope.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.1 vegur"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"response_body"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ok"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-01-21T16:26:12Z"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="dark-box">
|
|
<div class="lang-selector">
|
|
<a href="#" data-language-name="shell">cURL</a>
|
|
<a href="#" data-language-name="javascript">Node.js</a>
|
|
<a href="#" data-language-name="python">Python</a>
|
|
<a href="#" data-language-name="php">PHP</a>
|
|
<a href="#" data-language-name="ruby">Ruby</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="warning-top">
|
|
<i class="info"></i> This documentation is for the WooCommerce API v2 which is now deprecated. <a href="http://woocommerce.github.io/woocommerce-rest-api-docs/">Please use the latest REST API version</a>.
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|
