mirror of
https://gh.wpcy.net/https://github.com/woocommerce/woocommerce-rest-api-docs.git
synced 2026-04-24 04:42:50 +08:00
25393 lines
2.4 MiB
25393 lines
2.4 MiB
|
|
<!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 - WP REST API v1</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="wp-api-v1 has-warning" data-languages="["shell","javascript","php","python","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="php">PHP</a>
|
|
<a href="#" data-language-name="python">Python</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="#request-response-format" class="toc-h2 toc-link" data-title="Request/Response Format">Request/Response Format</a>
|
|
</li>
|
|
<li>
|
|
<a href="#errors" class="toc-h2 toc-link" data-title="Errors">Errors</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="#libraries-and-tools" class="toc-h2 toc-link" data-title="Libraries and Tools">Libraries and Tools</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#rest-api-keys" class="toc-h2 toc-link" data-title="REST API keys">REST API keys</a>
|
|
</li>
|
|
<li>
|
|
<a href="#authentication-over-https" class="toc-h2 toc-link" data-title="Authentication over HTTPS">Authentication over HTTPS</a>
|
|
</li>
|
|
<li>
|
|
<a href="#authentication-over-http" class="toc-h2 toc-link" data-title="Authentication over HTTP">Authentication over HTTP</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="#http-request" class="toc-h2 toc-link" data-title="HTTP request">HTTP request</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="#retrieve-a-coupon" class="toc-h2 toc-link" data-title="Retrieve a coupon">Retrieve a coupon</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-coupons" class="toc-h2 toc-link" data-title="List all coupons">List all 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="#batch-update-coupons" class="toc-h2 toc-link" data-title="Batch update coupons">Batch update coupons</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="#customer-properties" class="toc-h2 toc-link" data-title="Customer properties">Customer 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="#retrieve-a-customer" class="toc-h2 toc-link" data-title="Retrieve a customer">Retrieve a customer</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-customers" class="toc-h2 toc-link" data-title="List all customers">List all 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="#batch-update-customers" class="toc-h2 toc-link" data-title="Batch update customers">Batch update customers</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-customer-downloads" class="toc-h2 toc-link" data-title="Retrieve customer downloads">Retrieve customer downloads</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="#order-properties" class="toc-h2 toc-link" data-title="Order properties">Order 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="#retrieve-an-order" class="toc-h2 toc-link" data-title="Retrieve an order">Retrieve an order</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-orders" class="toc-h2 toc-link" data-title="List all orders">List all 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="#batch-update-orders" class="toc-h2 toc-link" data-title="Batch update orders">Batch update orders</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#order-notes" class="toc-h1 toc-link" data-title="Order notes">Order notes</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#order-note-properties" class="toc-h2 toc-link" data-title="Order note properties">Order note properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-an-order-note" class="toc-h2 toc-link" data-title="Create an order note">Create an order note</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-an-order-note" class="toc-h2 toc-link" data-title="Retrieve an order note">Retrieve an order note</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-order-notes" class="toc-h2 toc-link" data-title="List all order notes">List all order notes</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>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#refunds" class="toc-h1 toc-link" data-title="Refunds">Refunds</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#refund-properties" class="toc-h2 toc-link" data-title="Refund properties">Refund properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-refund" class="toc-h2 toc-link" data-title="Create a refund">Create a refund</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-refund" class="toc-h2 toc-link" data-title="Retrieve a refund">Retrieve a refund</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-refunds" class="toc-h2 toc-link" data-title="List all refunds">List all refunds</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-refund" class="toc-h2 toc-link" data-title="Delete a refund">Delete a 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="#product-properties" class="toc-h2 toc-link" data-title="Product properties">Product 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="#retrieve-a-product" class="toc-h2 toc-link" data-title="Retrieve a product">Retrieve a product</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-products" class="toc-h2 toc-link" data-title="List all products">List all 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="#batch-update-products" class="toc-h2 toc-link" data-title="Batch update products">Batch update products</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-product-reviews" class="toc-h2 toc-link" data-title="Retrieve product reviews">Retrieve product reviews</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-product-reviews" class="toc-h2 toc-link" data-title="List all product reviews">List all product reviews</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#product-attributes" class="toc-h1 toc-link" data-title="Product attributes">Product attributes</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#product-attribute-properties" class="toc-h2 toc-link" data-title="Product attribute properties">Product attribute properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-product-attribute" class="toc-h2 toc-link" data-title="Create a product attribute">Create a product attribute</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-product-attribute" class="toc-h2 toc-link" data-title="Retrieve a product attribute">Retrieve a product attribute</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-product-attributes" class="toc-h2 toc-link" data-title="List all product attributes">List all product attributes</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-product-attribute" class="toc-h2 toc-link" data-title="Update a product attribute">Update a product attribute</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-product-attribute" class="toc-h2 toc-link" data-title="Delete a product attribute">Delete a product attribute</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-product-attributes" class="toc-h2 toc-link" data-title="Batch update product attributes">Batch update product attributes</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#product-attribute-terms" class="toc-h1 toc-link" data-title="Product attribute terms">Product attribute terms</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#attribute-term-properties" class="toc-h2 toc-link" data-title="Attribute term properties">Attribute term properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-an-attribute-term" class="toc-h2 toc-link" data-title="Create an attribute term">Create an attribute term</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-an-attribute-term" class="toc-h2 toc-link" data-title="Retrieve an attribute term">Retrieve an attribute term</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-attribute-terms" class="toc-h2 toc-link" data-title="List all attribute terms">List all attribute terms</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-an-attribute-term" class="toc-h2 toc-link" data-title="Update an attribute term">Update an attribute term</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-an-attribute-term" class="toc-h2 toc-link" data-title="Delete an attribute term">Delete an attribute term</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-attribute-terms" class="toc-h2 toc-link" data-title="Batch update attribute terms">Batch update attribute terms</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#product-categories" class="toc-h1 toc-link" data-title="Product categories">Product categories</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#product-category-properties" class="toc-h2 toc-link" data-title="Product category properties">Product category properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-product-category" class="toc-h2 toc-link" data-title="Create a product category">Create a product category</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-product-category" class="toc-h2 toc-link" data-title="Retrieve a product category">Retrieve a product category</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-product-categories" class="toc-h2 toc-link" data-title="List all product categories">List all product categories</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-product-category" class="toc-h2 toc-link" data-title="Update a product category">Update a product category</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-product-category" class="toc-h2 toc-link" data-title="Delete a product category">Delete a product category</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-product-categories" class="toc-h2 toc-link" data-title="Batch update product categories">Batch update product categories</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#product-shipping-classes" class="toc-h1 toc-link" data-title="Product shipping classes">Product shipping classes</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#shipping-class-properties" class="toc-h2 toc-link" data-title="Shipping class properties">Shipping class properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-shipping-class" class="toc-h2 toc-link" data-title="Create a shipping class">Create a shipping class</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-shipping-class" class="toc-h2 toc-link" data-title="Retrieve a shipping class">Retrieve a shipping class</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-shipping-classes" class="toc-h2 toc-link" data-title="List all shipping classes">List all shipping classes</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-shipping-class" class="toc-h2 toc-link" data-title="Update a shipping class">Update a shipping class</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-shipping-class" class="toc-h2 toc-link" data-title="Delete a shipping class">Delete a shipping class</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-shipping-classes" class="toc-h2 toc-link" data-title="Batch update shipping classes">Batch update shipping classes</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#product-tags" class="toc-h1 toc-link" data-title="Product tags">Product tags</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#product-tag-properties" class="toc-h2 toc-link" data-title="Product tag properties">Product tag properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-product-tag" class="toc-h2 toc-link" data-title="Create a product tag">Create a product tag</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-product-tag" class="toc-h2 toc-link" data-title="Retrieve a product tag">Retrieve a product tag</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-product-tags" class="toc-h2 toc-link" data-title="List all product tags">List all product tags</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-product-tag" class="toc-h2 toc-link" data-title="Update a product tag">Update a product tag</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-product-tag" class="toc-h2 toc-link" data-title="Delete a product tag">Delete a product tag</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-product-tags" class="toc-h2 toc-link" data-title="Batch update product tags">Batch update product tags</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="#list-all-reports" class="toc-h2 toc-link" data-title="List all reports">List all reports</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-sales-report" class="toc-h2 toc-link" data-title="Retrieve sales report">Retrieve sales report</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-top-sellers-report" class="toc-h2 toc-link" data-title="Retrieve top sellers report">Retrieve top sellers report</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#tax-rates" class="toc-h1 toc-link" data-title="Tax rates">Tax rates</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#tax-rate-properties" class="toc-h2 toc-link" data-title="Tax rate properties">Tax rate properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-tax-rate" class="toc-h2 toc-link" data-title="Create a tax rate">Create a tax rate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-tax-rate" class="toc-h2 toc-link" data-title="Retrieve a tax rate">Retrieve a tax rate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-tax-rates" class="toc-h2 toc-link" data-title="List all tax rates">List all tax rates</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-tax-rate" class="toc-h2 toc-link" data-title="Update a tax rate">Update a tax rate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-tax-rate" class="toc-h2 toc-link" data-title="Delete a tax rate">Delete a tax rate</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-tax-rates" class="toc-h2 toc-link" data-title="Batch update tax rates">Batch update tax rates</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#tax-classes" class="toc-h1 toc-link" data-title="Tax classes">Tax classes</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#tax-class-properties" class="toc-h2 toc-link" data-title="Tax class properties">Tax class properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-tax-class" class="toc-h2 toc-link" data-title="Create a tax class">Create a tax class</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-tax-classes" class="toc-h2 toc-link" data-title="List all tax classes">List all tax classes</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-tax-class" class="toc-h2 toc-link" data-title="Delete a tax class">Delete a tax class</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="#topics" class="toc-h2 toc-link" data-title="Topics">Topics</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delivery-payload" class="toc-h2 toc-link" data-title="Delivery/payload">Delivery/payload</a>
|
|
</li>
|
|
<li>
|
|
<a href="#logging" class="toc-h2 toc-link" data-title="Logging">Logging</a>
|
|
</li>
|
|
<li>
|
|
<a href="#visual-interface" class="toc-h2 toc-link" data-title="Visual interface">Visual interface</a>
|
|
</li>
|
|
<li>
|
|
<a href="#webhook-properties" class="toc-h2 toc-link" data-title="Webhook properties">Webhook 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="#retrieve-a-webhook" class="toc-h2 toc-link" data-title="Retrieve a webhook">Retrieve a webhook</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-webhooks" class="toc-h2 toc-link" data-title="List all webhooks">List all 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="#batch-update-webhooks" class="toc-h2 toc-link" data-title="Batch update webhooks">Batch update webhooks</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-webhook-delivery" class="toc-h2 toc-link" data-title="Retrieve webhook delivery">Retrieve webhook delivery</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-webhook-deliveries" class="toc-h2 toc-link" data-title="List all webhook deliveries">List all webhook 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>WooCommerce (WC) 2.6+ is fully integrated with the WordPress <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">REST</a> API. This allows WC data to be created, read, updated, and deleted using requests in JSON format and using WordPress REST API Authentication methods and standard HTTP verbs which are understood by most HTTP clients.</p>
|
|
|
|
<p>The current WP REST API integration version is <code>v1</code> which takes a first-order position in endpoints. </p>
|
|
|
|
<p>The following table shows API versions present in each major version of WooCommerce:</p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>API Version</th>
|
|
<th>WC Version</th>
|
|
<th>WP Version</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>v1</code></td>
|
|
<td>2.6.x or later</td>
|
|
<td>4.4 or later</td>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<p>Prior to 2.6, WooCommerce had a REST API separate from WordPress which is now known as the legacy API. You can find the documentation for the legacy API separately.</p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>API Version</th>
|
|
<th>WC Version</th>
|
|
<th>WP Version</th>
|
|
<th>Documentation</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>Legacy v3</code></td>
|
|
<td>2.4.x or later</td>
|
|
<td>4.1 or later</td>
|
|
<td><a href="v3.html">Legacy v3 docs</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Legacy v2</code></td>
|
|
<td>2.2.x or later</td>
|
|
<td>4.1 or later</td>
|
|
<td><a href="v2.html">Legacy v2 docs</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Legacy v1</code></td>
|
|
<td>2.1.x or later</td>
|
|
<td>4.1 or later</td>
|
|
<td><a href="v1.html">Legacy v1 docs</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='requirements'>Requirements</h2>
|
|
<p>To use the latest version of the REST API you must be using:</p>
|
|
|
|
<ul>
|
|
<li>WooCommerce 2.6+.</li>
|
|
<li>WordPress 4.4+.</li>
|
|
<li>Pretty permalinks in <code>Settings > Permalinks</code> so that the custom endpoints are supported. <strong>Default permalinks will not work.</strong></li>
|
|
<li>You may access the API over either HTTP or HTTPS, but <em>HTTPS is recommended where possible</em>.</li>
|
|
</ul>
|
|
|
|
<p>If you use ModSecurity and see <code>501 Method Not Implemented</code> errors, see <a href="https://github.com/woocommerce/woocommerce/issues/9838">this issue</a> for details.</p>
|
|
|
|
<aside class="notice">
|
|
Please note that you are <strong>not</strong> required to install the <a href="https://wordpress.org/plugins/rest-api/" target="_blank">WP REST API (WP API)</a> plugin.
|
|
</aside>
|
|
<h2 id='request-response-format'>Request/Response Format</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>Dates are returned in ISO8601 format: <code>YYYY-MM-DDTHH:MM:SS</code></li>
|
|
<li>Resource IDs are returned as integers.</li>
|
|
<li>Any decimal monetary amount, such as prices or totals, will be returned as strings with two decimal places.</li>
|
|
<li>Other amounts, such as item counts, are returned as integers.</li>
|
|
<li>Blank fields are generally included as <code>null</code> or emtpy string instead of being omitted.</li>
|
|
</ul>
|
|
<h3 id='jsonp-support'>JSONP Support</h3>
|
|
<p>The WP REST API supports JSONP by default. JSONP responses use 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>/wp-json/wc/v1?_jsonp=callback</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/tags/34?_jsonp<span class="o">=</span>tagDetails <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="s2">products/tags/34</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">_jsonp</span><span class="p">:</span> <span class="dl">"</span><span class="s2">tagDetails</span><span class="dl">"</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/tags/34'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'_jsonp'</span> <span class="o">=></span> <span class="s1">'tagDetails'</span><span class="p">]));</span> <span class="cp">?></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/tags/34?_jsonp=tagDetails"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/tags/34"</span><span class="p">,</span> <span class="ss">_jsonp: </span><span class="s2">"tagDetails"</span><span class="p">).</span><span class="nf">parsed_response</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>Response:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight plaintext"><code>/**/tagDetails({"id":34,"name":"Leather Shoes","slug":"leather-shoes","description":"","count":0,"_links":{"self":[{"href":"https://example.com/wp-json/wc/v1/products/tags/34"}],"collection":[{"href":"https://example.com/wp-json/wc/v1/products/tags"}]}})%
|
|
</code></pre></div><h2 id='errors'>Errors</h2>
|
|
<p>Occasionally you might encounter errors when accessing the REST API. There are four possible types:</p>
|
|
|
|
<table><thead>
|
|
<tr>
|
|
<th>Error Code</th>
|
|
<th>Error Type</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>400 Bad Request</code></td>
|
|
<td>Invalid request, e.g. using an unsupported HTTP method</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>401 Unauthorized</code></td>
|
|
<td>Authentication or permission error, e.g. incorrect API keys</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>404 Not Found</code></td>
|
|
<td>Requests to resources that don't exist or are missing</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>500 Internal Server Error</code></td>
|
|
<td>Server error</td>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<blockquote>
|
|
<p>WP REST API error example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest_no_route"</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">"No route was found matching the URL and request method"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">404</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>WooCommerce REST API error example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight json tab-json"><code><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_rest_term_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">"Resource doesn't exist."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">404</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>, <code>message</code> and <code>data</code> attribute.</p>
|
|
<h2 id='parameters'>Parameters</h2>
|
|
<p>Almost all endpoints accept optional parameters which can be passed as a HTTP query string parameter, e.g. <code>GET /orders?status=completed</code>. All parameters are documented along each endpoint.</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 specified with the <code>?per_page</code> parameter:</p>
|
|
|
|
<p><code>GET /orders?per_page=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>?offset</code> parameter:</p>
|
|
|
|
<p><code>GET /orders?offset=5</code></p>
|
|
|
|
<p>Page number is 1-based and omitting 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-WP-Total</code> and <code>X-WP-TotalPages</code> HTTP headers.</p>
|
|
<h3 id='link-header'>Link Header</h3>
|
|
<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/wp-json/wc/v1/products?page=2>; rel="next",
|
|
<https://www.example.com/wp-json/wc/v1/products?page=3>; rel="last"`
|
|
</code></pre></div>
|
|
<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='libraries-and-tools'>Libraries and Tools</h2><h3 id='official-libraries'>Official libraries</h3>
|
|
<ul>
|
|
<li><a href="https://www.npmjs.com/package/@woocommerce/woocommerce-rest-api">JavaScript</a> Library</li>
|
|
<li><a href="https://packagist.org/packages/automattic/woocommerce">PHP</a> Library</li>
|
|
<li><a href="https://pypi.python.org/pypi/WooCommerce">Python</a> Library</li>
|
|
<li><a href="https://rubygems.org/gems/woocommerce_api">Ruby</a> Library</li>
|
|
</ul>
|
|
<div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="c1">// Install:</span>
|
|
<span class="c1">// npm install --save @woocommerce/woocommerce-rest-api</span>
|
|
|
|
<span class="c1">// Setup:</span>
|
|
<span class="kd">const</span> <span class="nx">WooCommerceRestApi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">"</span><span class="s2">@woocommerce/woocommerce-rest-api</span><span class="dl">"</span><span class="p">).</span><span class="k">default</span><span class="p">;</span>
|
|
<span class="c1">// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api"; // Supports ESM</span>
|
|
|
|
<span class="kd">const</span> <span class="nx">WooCommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">WooCommerceRestApi</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">wc/v1</span><span class="dl">'</span> <span class="c1">// WooCommerce WP REST API version</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 automattic/woocommerce</span>
|
|
|
|
<span class="c1">// Setup:</span>
|
|
<span class="k">require</span> <span class="k">__DIR__</span> <span class="mf">.</span> <span class="s1">'/vendor/autoload.php'</span><span class="p">;</span>
|
|
|
|
<span class="kn">use</span> <span class="nc">Automattic\WooCommerce\Client</span><span class="p">;</span>
|
|
|
|
<span class="nv">$woocommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Client</span><span class="p">(</span>
|
|
<span class="s1">'http://example.com'</span><span class="p">,</span> <span class="c1">// Your store URL</span>
|
|
<span class="s1">'consumer_key'</span><span class="p">,</span> <span class="c1">// Your consumer key</span>
|
|
<span class="s1">'consumer_secret'</span><span class="p">,</span> <span class="c1">// Your consumer secret</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'wp_api'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span> <span class="c1">// Enable the WP REST API integration</span>
|
|
<span class="s1">'version'</span> <span class="o">=></span> <span class="s1">'wc/v1'</span> <span class="c1">// WooCommerce WP REST API version</span>
|
|
<span class="p">]</span>
|
|
<span class="p">);</span>
|
|
<span class="cp">?></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="c1"># Your store URL
|
|
</span> <span class="n">consumer_key</span><span class="o">=</span><span class="s">"consumer_key"</span><span class="p">,</span> <span class="c1"># Your consumer key
|
|
</span> <span class="n">consumer_secret</span><span class="o">=</span><span class="s">"consumer_secret"</span><span class="p">,</span> <span class="c1"># Your consumer secret
|
|
</span> <span class="n">wp_api</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="c1"># Enable the WP REST API integration
|
|
</span> <span class="n">version</span><span class="o">=</span><span class="s">"wc/v1"</span> <span class="c1"># WooCommerce WP REST API version
|
|
</span><span class="p">)</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="c1"># Your store URL</span>
|
|
<span class="s2">"consumer_key"</span><span class="p">,</span> <span class="c1"># Your consumer key</span>
|
|
<span class="s2">"consumer_secret"</span><span class="p">,</span> <span class="c1"># Your consumer secret</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">wp_json: </span><span class="kp">true</span><span class="p">,</span> <span class="c1"># Enable the WP REST API integration</span>
|
|
<span class="ss">version: </span><span class="s2">"v3"</span> <span class="c1"># WooCommerce WP REST API version</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div>
|
|
<aside class="notice">
|
|
Use the tabs in the top-right corner of this page to see how to install and use each library.
|
|
</aside>
|
|
<h3 id='third-party-libraries'>Third party libraries</h3>
|
|
<ul>
|
|
<li><a href="https://github.com/icoderman/wc-api-java">Java</a> Library</li>
|
|
<li><a href="https://github.com/XiaoFaye/WooCommerce.NET">.NET</a> Library</li>
|
|
<li><a href="https://github.com/gilokimu/WooDroid">Android</a> Library</li>
|
|
</ul>
|
|
|
|
<aside class="notice">
|
|
Note that we don't offer support for third party libraries, so if you have questions about how use any of this libraries you should contact the respective authors.
|
|
</aside>
|
|
<h3 id='tools'>Tools</h3>
|
|
<p>Some useful tools you can use to access the API include:</p>
|
|
|
|
<ul>
|
|
<li><a href="https://insomnia.rest">Insomnia</a> - Cross-platform GraphQL and REST client, available for Mac, Windows, and Linux.</li>
|
|
<li><a href="https://www.getpostman.com/">Postman</a> - Cross-platform REST client, available for Mac, Windows, and Linux.</li>
|
|
<li><a href="https://requestbin.com">RequestBin</a> - Allows you test webhooks.</li>
|
|
<li><a href="https://hookbin.com/">Hookbin</a> - Another tool to test webhooks.</li>
|
|
</ul>
|
|
<h1 id='authentication'>Authentication</h1>
|
|
<p>WooCommerce includes two ways to authenticate with the WP REST API. It is also possible to authenticate using any <a href="http://v2.wp-api.org/guide/authentication/">WP REST API authentication</a> plugin or method.</p>
|
|
<h2 id='rest-api-keys'>REST API keys</h2>
|
|
<p>Pre-generated keys can be used to authenticate use of the REST API endpoints. New keys can be generated either through the WordPress admin interface or they can be auto-generated through an endpoint.</p>
|
|
<h3 id='generating-api-keys-in-the-wordpress-admin-interface'>Generating API keys in the WordPress admin interface</h3>
|
|
<p>To create or manage keys for a specific WordPress user, go to WooCommerce > Settings > API > Keys/Apps.</p>
|
|
|
|
<p><img src="images/woocommerce-api-keys-settings-02dfb1f9.png" alt="WooCommerce REST API keys settings" /></p>
|
|
|
|
<p>Click the "Add Key" button. In the next screen, add a description and select the WordPress user you would like to generate the key for. Use of the REST API with the generated keys will conform to that user's WordPress roles and capabilities.</p>
|
|
|
|
<p>Choose the level of access for this REST API key, which can be <em>Read</em> access, <em>Write</em> access or <em>Read/Write</em> access. Then click the "Generate API Key" button and WooCommerce will generate REST API keys for the selected user.</p>
|
|
|
|
<p><img src="images/woocommerce-creating-api-keys-0f78883a.png" alt="Creating a new REST API key" /></p>
|
|
|
|
<p>Now that keys have been generated, you should see two new keys, a QRCode, and a Revoke API Key button. These two keys are your Consumer Key and Consumer Secret.</p>
|
|
|
|
<p><img src="images/woocommerce-api-key-generated-9004dc03.png" alt="Generated REST API key" /></p>
|
|
<h3 id='auto-generating-api-keys-using-our-application-authentication-endpoint'>Auto generating API keys using our Application Authentication Endpoint</h3>
|
|
<p>This endpoint can be used by any APP to <em>allow users to generate API keys</em> for your APP. This makes integration with WooCommerce API easier because the user only needs to grant access to your APP via a URL. After being redirected back to your APP, the API keys will be sent back in a separate POST request.</p>
|
|
|
|
<p>The following image illustrates how this works:</p>
|
|
|
|
<p><img src="images/woocommerce-auth-endpoint-flow-f04049df.png" alt="Authentication Endpoint flow" /></p>
|
|
|
|
<aside class="warning">
|
|
This endpoint works exclusively for users to generate API keys and facilitate integration between the WooCommerce REST API and an application. In no way is this endpoint intended to be used as login method for customers.
|
|
</aside>
|
|
<h4 id='url-parameters'>URL parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>app_name</code></td>
|
|
<td>string</td>
|
|
<td>Your APP name <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>scope</code></td>
|
|
<td>string</td>
|
|
<td>Level of access. Available: <code>read</code>, <code>write</code> and <code>read_write</code> <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>user_id</code></td>
|
|
<td>string</td>
|
|
<td>User ID in your APP. For your internal reference, used when the user is redirected back to your APP. NOT THE USER ID IN WOOCOMMERCE <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>return_url</code></td>
|
|
<td>string</td>
|
|
<td>URL the user will be redirected to after authentication <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>callback_url</code></td>
|
|
<td>string</td>
|
|
<td>URL that will receive the generated API key. Note: this URL should be over <strong>HTTPS</strong> <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='creating-an-authentication-endpoint-url'>Creating an authentication endpoint URL</h4>
|
|
<p>You must use the <code>/wc-auth/v1/authorize</code> endpoint and pass the above parameters as a query string.</p>
|
|
|
|
<blockquote>
|
|
<p>Example of how to build an authentication URL:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code><span class="c"># Bash example</span>
|
|
<span class="nv">STORE_URL</span><span class="o">=</span><span class="s1">'http://example.com'</span>
|
|
<span class="nv">ENDPOINT</span><span class="o">=</span><span class="s1">'/wc-auth/v1/authorize'</span>
|
|
<span class="nv">PARAMS</span><span class="o">=</span><span class="s2">"app_name=My App Name&scope=read_write&user_id=123&return_url=http://app.com/return-page&callback_url=https://app.com/callback-endpoint"</span>
|
|
<span class="nv">QUERY_STRING</span><span class="o">=</span><span class="s2">"</span><span class="si">$(</span>perl <span class="nt">-MURI</span>::Escape <span class="nt">-e</span> <span class="s1">'print uri_escape($ARGV[0]);'</span> <span class="s2">"</span><span class="nv">$PARAMS</span><span class="s2">"</span><span class="si">)</span><span class="s2">"</span>
|
|
<span class="nv">QUERY_STRING</span><span class="o">=</span><span class="si">$(</span><span class="nb">echo</span> <span class="nv">$QUERY_STRING</span> | <span class="nb">sed</span> <span class="nt">-e</span> <span class="s2">"s/%20/</span><span class="se">\+</span><span class="s2">/g"</span> <span class="nt">-e</span> <span class="s2">"s/%3D/</span><span class="se">\=</span><span class="s2">/g"</span> <span class="nt">-e</span> <span class="s2">"s/%26/</span><span class="se">\&</span><span class="s2">/g"</span><span class="si">)</span>
|
|
|
|
<span class="nb">echo</span> <span class="s2">"</span><span class="nv">$STORE_URL$ENDPOINT</span><span class="s2">?</span><span class="nv">$QUERY_STRING</span><span class="s2">"</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">querystring</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">"</span><span class="s2">querystring</span><span class="dl">"</span><span class="p">);</span>
|
|
|
|
<span class="kd">const</span> <span class="nx">store_url</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">http://example.com</span><span class="dl">"</span><span class="p">;</span>
|
|
<span class="kd">const</span> <span class="nx">endpoint</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">/wc-auth/v1/authorize</span><span class="dl">"</span><span class="p">;</span>
|
|
<span class="kd">const</span> <span class="nx">params</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">app_name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">My App Name</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">scope</span><span class="p">:</span> <span class="dl">"</span><span class="s2">read_write</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">user_id</span><span class="p">:</span> <span class="mi">123</span><span class="p">,</span>
|
|
<span class="na">return_url</span><span class="p">:</span> <span class="dl">"</span><span class="s2">http://app.com/return-page</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">callback_url</span><span class="p">:</span> <span class="dl">"</span><span class="s2">https://app.com/callback-endpoint</span><span class="dl">"</span>
|
|
<span class="p">};</span>
|
|
<span class="kd">const</span> <span class="nx">query_string</span> <span class="o">=</span> <span class="nx">querystring</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">params</span><span class="p">).</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/%20/g</span><span class="p">,</span> <span class="dl">"</span><span class="s2">+</span><span class="dl">"</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">store_url</span> <span class="o">+</span> <span class="nx">endpoint</span> <span class="o">+</span> <span class="dl">"</span><span class="s2">?</span><span class="dl">"</span> <span class="o">+</span> <span class="nx">query_string</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">$store_url</span> <span class="o">=</span> <span class="s1">'http://example.com'</span><span class="p">;</span>
|
|
<span class="nv">$endpoint</span> <span class="o">=</span> <span class="s1">'/wc-auth/v1/authorize'</span><span class="p">;</span>
|
|
<span class="nv">$params</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s1">'app_name'</span> <span class="o">=></span> <span class="s1">'My App Name'</span><span class="p">,</span>
|
|
<span class="s1">'scope'</span> <span class="o">=></span> <span class="s1">'write'</span><span class="p">,</span>
|
|
<span class="s1">'user_id'</span> <span class="o">=></span> <span class="mi">123</span><span class="p">,</span>
|
|
<span class="s1">'return_url'</span> <span class="o">=></span> <span class="s1">'http://app.com'</span><span class="p">,</span>
|
|
<span class="s1">'callback_url'</span> <span class="o">=></span> <span class="s1">'https://app.com'</span>
|
|
<span class="p">];</span>
|
|
<span class="nv">$query_string</span> <span class="o">=</span> <span class="nb">http_build_query</span><span class="p">(</span> <span class="nv">$params</span> <span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$store_url</span> <span class="mf">.</span> <span class="nv">$endpoint</span> <span class="mf">.</span> <span class="s1">'?'</span> <span class="mf">.</span> <span class="nv">$query_string</span><span class="p">;</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urlencode</span>
|
|
|
|
<span class="n">store_url</span> <span class="o">=</span> <span class="s">'http://example.com'</span>
|
|
<span class="n">endpoint</span> <span class="o">=</span> <span class="s">'/wc-auth/v1/authorize'</span>
|
|
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"app_name"</span><span class="p">:</span> <span class="s">"My App Name"</span><span class="p">,</span>
|
|
<span class="s">"scope"</span><span class="p">:</span> <span class="s">"read_write"</span><span class="p">,</span>
|
|
<span class="s">"user_id"</span><span class="p">:</span> <span class="mi">123</span><span class="p">,</span>
|
|
<span class="s">"return_url"</span><span class="p">:</span> <span class="s">"http://app.com/return-page"</span><span class="p">,</span>
|
|
<span class="s">"callback_url"</span><span class="p">:</span> <span class="s">"https://app.com/callback-endpoint"</span>
|
|
<span class="p">}</span>
|
|
<span class="n">query_string</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
|
|
|
|
<span class="k">print</span><span class="p">(</span><span class="s">"%s%s?%s"</span> <span class="o">%</span> <span class="p">(</span><span class="n">store_url</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">query_string</span><span class="p">))</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="nb">require</span> <span class="s2">"uri"</span>
|
|
|
|
<span class="n">store_url</span> <span class="o">=</span> <span class="s1">'http://example.com'</span>
|
|
<span class="n">endpoint</span> <span class="o">=</span> <span class="s1">'/wc-auth/v1/authorize'</span>
|
|
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">app_name: </span><span class="s2">"My App Name"</span><span class="p">,</span>
|
|
<span class="ss">scope: </span><span class="s2">"read_write"</span><span class="p">,</span>
|
|
<span class="ss">user_id: </span><span class="mi">123</span><span class="p">,</span>
|
|
<span class="ss">return_url: </span><span class="s2">"http://app.com/return-page"</span><span class="p">,</span>
|
|
<span class="ss">callback_url: </span><span class="s2">"https://app.com/callback-endpoint"</span>
|
|
<span class="p">}</span>
|
|
<span class="n">query_string</span> <span class="o">=</span> <span class="no">URI</span><span class="p">.</span><span class="nf">encode_www_form</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
|
|
|
|
<span class="nb">puts</span> <span class="s2">"</span><span class="si">#{</span><span class="n">store_url</span><span class="si">}#{</span><span class="n">endpoint</span><span class="si">}</span><span class="s2">?</span><span class="si">#{</span><span class="n">query_string</span><span class="si">}</span><span class="s2">"</span>
|
|
</code></pre></div>
|
|
<blockquote>
|
|
<p>Example of JSON posted with the API Keys</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight plaintext"><code>{
|
|
"key_id": 1,
|
|
"user_id": 123,
|
|
"consumer_key": "ck_xxxxxxxxxxxxxxxx",
|
|
"consumer_secret": "cs_xxxxxxxxxxxxxxxx",
|
|
"key_permissions": "read_write"
|
|
}
|
|
</code></pre></div>
|
|
<p>Example of the screen that the user will see:</p>
|
|
|
|
<p><img src="images/woocommerce-auth-endpoint-example-16e084bf.png" alt="Authentication Endpoint example" /></p>
|
|
<h4 id='notes'>Notes</h4>
|
|
<ul>
|
|
<li>While redirecting the user using <code>return_url</code>, you are also sent <code>success</code> and <code>user_id</code> parameters as query strings.</li>
|
|
<li><code>success</code> sends <code>0</code> if the user denied, or <code>1</code> if authenticated successfully.</li>
|
|
<li>Use <code>user_id</code> to identify the user when redirected back to the (<code>return_url</code>) and also remember to save the API Keys when your <code>callback_url</code> is posted to after auth.</li>
|
|
<li>The auth endpoint will send the API Keys in JSON format to the <code>callback_url</code>, so it's important to remember that some languages such as PHP will not display it inside the <code>$_POST</code> global variable, in PHP you can access it using <code>$HTTP_RAW_POST_DATA</code> (for old PHP versions) or <code>file_get_contents('php://input');</code>.</li>
|
|
<li>The URL generated must have all query string values encoded.</li>
|
|
</ul>
|
|
<h2 id='authentication-over-https'>Authentication over HTTPS</h2>
|
|
<p>You may use <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">HTTP Basic Auth</a> by providing the REST API Consumer Key as the username and the REST 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/wp-json/wc/v1/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="kd">const</span> <span class="nx">WooCommerceRestApi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">"</span><span class="s2">@woocommerce/woocommerce-rest-api</span><span class="dl">"</span><span class="p">).</span><span class="k">default</span><span class="p">;</span>
|
|
<span class="c1">// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api"; // Supports ESM</span>
|
|
|
|
<span class="kd">const</span> <span class="nx">WooCommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">WooCommerceRestApi</span><span class="p">({</span>
|
|
<span class="na">url</span><span class="p">:</span> <span class="dl">"</span><span class="s2">https://example.com</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">consumerKey</span><span class="p">:</span> <span class="dl">"</span><span class="s2">consumer_key</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">consumerSecret</span><span class="p">:</span> <span class="dl">"</span><span class="s2">consumer_secret</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">version</span><span class="p">:</span> <span class="dl">"</span><span class="s2">wc/v1</span><span class="dl">"</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="k">require</span> <span class="k">__DIR__</span> <span class="mf">.</span> <span class="s1">'/vendor/autoload.php'</span><span class="p">;</span>
|
|
|
|
<span class="kn">use</span> <span class="nc">Automattic\WooCommerce\Client</span><span class="p">;</span>
|
|
|
|
<span class="nv">$woocommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Client</span><span class="p">(</span>
|
|
<span class="s1">'https://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="p">[</span>
|
|
<span class="s1">'wp_api'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'version'</span> <span class="o">=></span> <span class="s1">'wc/v1'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">);</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><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">"https://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">wp_api</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
|
|
<span class="n">version</span><span class="o">=</span><span class="s">"wc/v1"</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><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">"https://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">wp_json: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">version: </span><span class="s2">"wc/v1"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div>
|
|
<p>Occasionally some servers may not parse the Authorization header correctly (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 instead.</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/wp-json/wc/v1/orders?consumer_key<span class="o">=</span>123&consumer_secret<span class="o">=</span>abc
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">WooCommerceRestApi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="dl">"</span><span class="s2">@woocommerce/woocommerce-rest-api</span><span class="dl">"</span><span class="p">).</span><span class="k">default</span><span class="p">;</span>
|
|
<span class="c1">// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api"; // Supports ESM</span>
|
|
|
|
<span class="kd">const</span> <span class="nx">WooCommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">WooCommerceRestApi</span><span class="p">({</span>
|
|
<span class="na">url</span><span class="p">:</span> <span class="dl">"</span><span class="s2">https://example.com</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">consumerKey</span><span class="p">:</span> <span class="dl">"</span><span class="s2">consumer_key</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">consumerSecret</span><span class="p">:</span> <span class="dl">"</span><span class="s2">consumer_secret</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">version</span><span class="p">:</span> <span class="dl">"</span><span class="s2">wc/v1</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">queryStringAuth</span><span class="p">:</span> <span class="kc">true</span> <span class="c1">// Force Basic Authentication as query string true and using under HTTPS</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="k">require</span> <span class="k">__DIR__</span> <span class="mf">.</span> <span class="s1">'/vendor/autoload.php'</span><span class="p">;</span>
|
|
|
|
<span class="kn">use</span> <span class="nc">Automattic\WooCommerce\Client</span><span class="p">;</span>
|
|
|
|
<span class="nv">$woocommerce</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Client</span><span class="p">(</span>
|
|
<span class="s1">'https://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="p">[</span>
|
|
<span class="s1">'wp_api'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'version'</span> <span class="o">=></span> <span class="s1">'wc/v1'</span><span class="p">,</span>
|
|
<span class="s1">'query_string_auth'</span> <span class="o">=></span> <span class="kc">true</span> <span class="c1">// Force Basic Authentication as query string true and using under HTTPS</span>
|
|
<span class="p">]</span>
|
|
<span class="p">);</span>
|
|
<span class="cp">?></span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight python tab-python"><code><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">"https://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">wp_api</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
|
|
<span class="n">version</span><span class="o">=</span><span class="s">"wc/v1"</span><span class="p">,</span>
|
|
<span class="n">query_string_auth</span><span class="o">=</span><span class="bp">True</span> <span class="o">//</span> <span class="n">Force</span> <span class="n">Basic</span> <span class="n">Authentication</span> <span class="k">as</span> <span class="n">query</span> <span class="n">string</span> <span class="n">true</span> <span class="ow">and</span> <span class="n">using</span> <span class="n">under</span> <span class="n">HTTPS</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><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">"https://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">wp_json: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">version: </span><span class="s2">"wc/v1"</span><span class="p">,</span>
|
|
<span class="ss">query_string_auth: </span><span class="kp">true</span> <span class="sr">//</span> <span class="no">Force</span> <span class="no">Basic</span> <span class="no">Authentication</span> <span class="n">as</span> <span class="n">query</span> <span class="n">string</span> <span class="kp">true</span> <span class="n">and</span> <span class="n">using</span> <span class="n">under</span> <span class="no">HTTPS</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
</code></pre></div><h2 id='authentication-over-http'>Authentication over HTTP</h2>
|
|
<p>You must use <a href="http://tools.ietf.org/html/rfc5849">OAuth 1.0a "one-legged" authentication</a> to ensure REST API credentials cannot be intercepted by an attacker. Typically you will use any standard OAuth 1.0a library in the language of your choice to handle the authentication, or generate the necessary parameters by following the following instructions.</p>
|
|
<h3 id='creating-a-signature'>Creating a signature</h3><h4 id='collect-the-request-method-and-url'>Collect the request method and URL</h4>
|
|
<p>First you need to determine the HTTP method you will be using for the request, and the URL of the request.</p>
|
|
|
|
<p>The <strong>HTTP method</strong> will be <code>GET</code> in our case.</p>
|
|
|
|
<p>The <strong>Request URL</strong> will be the endpoint you are posting to, e.g. <code>http://www.example.com/wp-json/wc/v1/orders</code>.</p>
|
|
<h4 id='collect-parameters'>Collect parameters</h4>
|
|
<p>Collect and normalize your query string parameters. This includes all <code>oauth_*</code> parameters except for the <code>oauth_signature</code> itself.</p>
|
|
|
|
<p>These values need to be encoded into a single string which will be used later on. The process to build the string is very specific:</p>
|
|
|
|
<ol>
|
|
<li><a href="https://dev.twitter.com/oauth/overview/percent-encoding-parameters">Percent encode</a> every key and value that will be signed.</li>
|
|
<li>Sort the list of parameters alphabetically by encoded key.</li>
|
|
<li>For each key/value pair:
|
|
|
|
<ul>
|
|
<li>Append the encoded key to the output string.</li>
|
|
<li>Append the <code>=</code> character to the output string.</li>
|
|
<li>Append the encoded value to the output string.</li>
|
|
<li>If there are more key/value pairs remaining, append a <code>&</code> character to the output string.</li>
|
|
</ul></li>
|
|
</ol>
|
|
|
|
<p>When percent encoding in PHP for example, you would use <code>rawurlencode()</code>.</p>
|
|
|
|
<p>When sorting parameters in PHP for example, you would use <code>uksort( $params, 'strcmp' )</code>.</p>
|
|
|
|
<blockquote>
|
|
<p>Parameters example:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight plaintext"><code>oauth_consumer_key=abc123&oauth_signature_method=HMAC-SHA1
|
|
</code></pre></div><h4 id='create-the-signature-base-string'>Create the signature base string</h4>
|
|
<p>The above values collected so far must be joined to make a single string, from which the signature will be generated. This is called the signature base string in the OAuth specification.</p>
|
|
|
|
<p>To encode the HTTP method, request URL, and parameter string into a single string:</p>
|
|
|
|
<ol>
|
|
<li>Set the output string equal to the uppercase <strong>HTTP Method</strong>.</li>
|
|
<li>Append the <code>&</code> character to the output string.</li>
|
|
<li><a href="https://dev.twitter.com/oauth/overview/percent-encoding-parameters">Percent encode</a> the URL and append it to the output string.</li>
|
|
<li>Append the <code>&</code> character to the output string.</li>
|
|
<li><a href="https://dev.twitter.com/oauth/overview/percent-encoding-parameters">Percent encode</a> the parameter string and append it to the output string.</li>
|
|
</ol>
|
|
|
|
<blockquote>
|
|
<p>Example signature base string:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight plaintext"><code>GET&http%3A%2F%2Fwww.example.com%2Fwp-json%2Fwc%2Fv1%2Forders&oauth_consumer_key%3Dabc123%26oauth_signature_method%3DHMAC-SHA1
|
|
</code></pre></div><h4 id='generate-the-signature'>Generate the signature</h4>
|
|
<p>Generate the signature using the <em>signature base string</em> and your consumer secret key with a <code>&</code> character with the HMAC-SHA1 hashing algorithm.</p>
|
|
|
|
<p>In PHP you can use the <a href="http://php.net/manual/en/function.hash-hmac.php">hash_hmac</a> function.</p>
|
|
|
|
<p>HMAC-SHA1 or HMAC-SHA256 are the only accepted hash algorithms.</p>
|
|
|
|
<p>If you are having trouble generating a correct signature, you'll want to review the string you are signing for encoding errors. 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>
|
|
<h3 id='oauth-tips'>OAuth tips</h3>
|
|
<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>
|
|
<h1 id='index'>Index</h1>
|
|
<p>By default, the API provides information about all available endpoints on the site. Authentication is not required to access the API index.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1
|
|
</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="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">''</span><span class="p">));</span> <span class="cp">?></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 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">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</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">"/wc/v1"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</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">"_links"</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">"https://example.com/wp-json/wc/v1"</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/v1/coupons"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"after"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published after a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"before"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published before a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"desc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to posts with a specific slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"filter"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Use WP Query arguments to modify the response; private query vars require appropriate authorization."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources with a specific code."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupon description."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"discount_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </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="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"fixed_product"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"percent_product"</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">"Determines the type of discount that will be applied."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The amount of discount."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"UTC DateTime when the coupon expires."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether coupon can only be used individually."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of product ID's the coupon can be used on."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of product ID's the coupon cannot be used on."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"How many times the coupon can be used."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"How many times the coupon can be used per customer."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Max number of items in the cart the coupon can be applied to."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if can be applied for free shipping."</span><span class="w">
|
|
</span><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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of category ID's the coupon applies to."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of category ID's the coupon does not apply to."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if should not apply when have sale items."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Minimum order amount that needs to be in the cart before coupon applies."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum order amount allowed when using the coupon."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of email addresses that can use this coupon."</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">"_links"</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">"https://example.com/wp-json/wc/v1/coupons"</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/v1/coupons/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupon code."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupon description."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"discount_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </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="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"fixed_product"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"percent_product"</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">"Determines the type of discount that will be applied."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The amount of discount."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"UTC DateTime when the coupon expires."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether coupon can only be used individually."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of product ID's the coupon can be used on."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of product ID's the coupon cannot be used on."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"How many times the coupon can be used."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"How many times the coupon can be used per customer."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Max number of items in the cart the coupon can be applied to."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if can be applied for free shipping."</span><span class="w">
|
|
</span><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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of category ID's the coupon applies to."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of category ID's the coupon does not apply to."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if should not apply when have sale items."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Minimum order amount that needs to be in the cart before coupon applies."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum order amount allowed when using the coupon."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of email addresses that can use this coupon."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to bypass trash and force deletion."</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="nl">"/wc/v1/coupons/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupon code."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupon description."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"discount_type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </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="s2">"percent"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"fixed_product"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"percent_product"</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">"Determines the type of discount that will be applied."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The amount of discount."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"UTC DateTime when the coupon expires."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether coupon can only be used individually."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of product ID's the coupon can be used on."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of product ID's the coupon cannot be used on."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"How many times the coupon can be used."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"How many times the coupon can be used per customer."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Max number of items in the cart the coupon can be applied to."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"free_shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if can be applied for free shipping."</span><span class="w">
|
|
</span><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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of category ID's the coupon applies to."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of category ID's the coupon does not apply to."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if should not apply when have sale items."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Minimum order amount that needs to be in the cart before coupon applies."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum order amount allowed when using the coupon."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of email addresses that can use this coupon."</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">"_links"</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">"https://example.com/wp-json/wc/v1/coupons/batch"</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/v1/customers/(?P<customer_id>[\\d]+)/downloads"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</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">"Scope under which the request is made; determines fields present in response."</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="nl">"/wc/v1/customers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"registered_date"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources with a specific email."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"role"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"customer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"all"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"administrator"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"editor"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"author"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"contributor"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"subscriber"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"customer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"shop_manager"</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">"Limit result set to resources with a specific role."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"first_name"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer first name."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer last name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"password"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of billing address data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of shipping address data."</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">"_links"</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">"https://example.com/wp-json/wc/v1/customers"</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/v1/customers/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The email address for the customer."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer first name."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer last name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer login name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"password"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer password."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of billing address data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of shipping address data."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"reassign"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/wc/v1/customers/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The email address for the customer."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer first name."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer last name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer login name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"password"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Customer password."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of billing address data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of shipping address data."</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">"_links"</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">"https://example.com/wp-json/wc/v1/customers/batch"</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/v1/orders/(?P<order_id>[\\d]+)/notes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shows/define if the note is only for reference or for the customer (the user will be notified)."</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="nl">"/wc/v1/orders/(?P<order_id>[\\d]+)/notes/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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">"DELETE"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/orders/(?P<order_id>[\\d]+)/refunds"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"after"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published after a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"before"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published before a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"desc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to posts with a specific slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"filter"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Use WP Query arguments to modify the response; private query vars require appropriate authorization."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"dp"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Number of decimal points to use in each resource."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"amount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Refund amount."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reason for refund"</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Line items data."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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="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">"/wc/v1/orders/(?P<order_id>[\\d]+)/refunds/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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">"DELETE"</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"reassign"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/wc/v1/orders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"after"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published after a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"before"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published before a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"desc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to posts with a specific slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"filter"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Use WP Query arguments to modify the response; private query vars require appropriate authorization."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"any"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"any"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"processing"</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="s2">"completed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"cancelled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"refunded"</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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to orders assigned a specific status."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to orders assigned a specific customer."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to orders assigned a specific product."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"dp"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Number of decimal points to use in each resource."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Parent order ID."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"processing"</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="s2">"completed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"cancelled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"refunded"</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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order status."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BRL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"AED"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AFN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ALL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ANG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AOA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ARS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AUD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AWG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AZN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BAM"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BBD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BDT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BGN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BHD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BIF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BOB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BRL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BSD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BTC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BTN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BWP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BYR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CDF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CHF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CLP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CNY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"COP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CRC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CUC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CUP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CVE"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CZK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DJF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DKK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"EGP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ERN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ETB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"EUR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"FJD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"FKP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GBP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GEL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GGP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GHS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GIP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GNF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GTQ"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HKD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HNL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HRK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HTG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HUF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IDR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ILS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IMP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"INR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IQD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IRR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ISK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JEP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JOD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JPY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KES"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KGS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KHR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KMF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KPW"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KRW"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KWD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KZT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LAK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LBP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LKR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LRD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LSL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MDL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MGA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MKD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MMK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MNT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MRO"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MUR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MVR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MWK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MXN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MYR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MZN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NGN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NIO"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NOK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NPR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"OMR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PAB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PEN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PGK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PHP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PKR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PLN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PRB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PYG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"QAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RON"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RSD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RUB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RWF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SBD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SCR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SDG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SEK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SGD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SHP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SLL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SOS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SRD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SSP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"STD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SYP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SZL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"THB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TJS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TMT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TRY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TTD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TWD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TZS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UAH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UGX"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UYU"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UZS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VEF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VUV"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"WST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XAF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XCD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XOF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XPF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"YER"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ZAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ZMW"</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">"Currency the order was created with, in ISO format."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"User ID who owns the order. 0 for guests."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Billing address."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping address."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"payment_method"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method ID."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"payment_method_title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method title."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"set_paid"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if the order is paid. It will set the status to processing and reduce stock items."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"transaction_id"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Unique transaction ID."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Note left by customer during checkout."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Line items data."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping lines data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fee lines data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupons line data."</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">"_links"</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">"https://example.com/wp-json/wc/v1/orders"</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/v1/orders/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Parent order ID."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"processing"</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="s2">"completed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"cancelled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"refunded"</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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order status."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"AED"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AFN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ALL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ANG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AOA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ARS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AUD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AWG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AZN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BAM"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BBD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BDT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BGN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BHD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BIF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BOB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BRL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BSD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BTC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BTN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BWP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BYR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CDF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CHF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CLP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CNY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"COP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CRC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CUC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CUP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CVE"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CZK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DJF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DKK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"EGP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ERN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ETB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"EUR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"FJD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"FKP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GBP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GEL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GGP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GHS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GIP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GNF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GTQ"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HKD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HNL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HRK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HTG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HUF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IDR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ILS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IMP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"INR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IQD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IRR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ISK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JEP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JOD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JPY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KES"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KGS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KHR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KMF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KPW"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KRW"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KWD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KZT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LAK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LBP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LKR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LRD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LSL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MDL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MGA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MKD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MMK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MNT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MRO"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MUR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MVR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MWK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MXN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MYR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MZN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NGN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NIO"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NOK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NPR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"OMR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PAB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PEN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PGK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PHP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PKR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PLN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PRB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PYG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"QAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RON"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RSD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RUB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RWF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SBD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SCR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SDG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SEK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SGD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SHP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SLL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SOS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SRD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SSP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"STD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SYP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SZL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"THB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TJS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TMT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TRY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TTD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TWD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TZS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UAH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UGX"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UYU"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UZS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VEF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VUV"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"WST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XAF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XCD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XOF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XPF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"YER"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ZAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ZMW"</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">"Currency the order was created with, in ISO format."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"User ID who owns the order. 0 for guests."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Billing address."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping address."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"payment_method"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method ID."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"payment_method_title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method title."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"set_paid"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if the order is paid. It will set the status to processing and reduce stock items."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"transaction_id"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Unique transaction ID."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Note left by customer during checkout."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Line items data."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping lines data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fee lines data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupons line data."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to bypass trash and force deletion."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"reassign"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/wc/v1/orders/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Parent order ID."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"processing"</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="s2">"completed"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"cancelled"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"refunded"</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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order status."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"AED"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AFN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ALL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ANG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AOA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ARS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AUD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AWG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"AZN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BAM"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BBD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BDT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BGN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BHD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BIF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BOB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BRL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BSD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BTC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BTN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BWP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BYR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"BZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CDF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CHF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CLP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CNY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"COP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CRC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CUC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CUP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CVE"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"CZK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DJF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DKK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"DZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"EGP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ERN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ETB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"EUR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"FJD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"FKP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GBP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GEL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GGP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GHS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GIP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GNF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GTQ"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"GYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HKD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HNL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HRK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HTG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"HUF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IDR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ILS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IMP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"INR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IQD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"IRR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ISK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JEP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JMD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JOD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"JPY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KES"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KGS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KHR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KMF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KPW"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KRW"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KWD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"KZT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LAK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LBP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LKR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LRD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LSL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"LYD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MDL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MGA"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MKD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MMK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MNT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MRO"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MUR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MVR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MWK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MXN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MYR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"MZN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NAD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NGN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NIO"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NOK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NPR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"NZD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"OMR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PAB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PEN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PGK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PHP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PKR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PLN"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PRB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"PYG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"QAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RON"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RSD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RUB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"RWF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SBD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SCR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SDG"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SEK"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SGD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SHP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SLL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SOS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SRD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SSP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"STD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SYP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"SZL"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"THB"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TJS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TMT"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TOP"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TRY"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TTD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TWD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"TZS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UAH"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UGX"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UYU"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"UZS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VEF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VND"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"VUV"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"WST"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XAF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XCD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XOF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"XPF"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"YER"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ZAR"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"ZMW"</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">"Currency the order was created with, in ISO format."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"User ID who owns the order. 0 for guests."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"billing"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Billing address."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping address."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"payment_method"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method ID."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"payment_method_title"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method title."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"set_paid"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Define if the order is paid. It will set the status to processing and reduce stock items."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"transaction_id"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Unique transaction ID."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Note left by customer during checkout."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Line items data."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping lines data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fee lines data."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupons line data."</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">"_links"</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">"https://example.com/wp-json/wc/v1/orders/batch"</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/v1/products/attributes/(?P<attribute_id>[\\d]+)/terms"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"term_group"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"description"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"count"</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">"Sort collection by resource attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"hide_empty"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to hide resources not assigned to any products."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources assigned to a specific parent."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources assigned to a specific product."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources with a specific slug."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort the resource."</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="nl">"/wc/v1/products/attributes/(?P<attribute_id>[\\d]+)/terms/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Term name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort the resource."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/products/attributes/(?P<attribute_id>[\\d]+)/terms/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Term name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort the resource."</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="nl">"/wc/v1/products/attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"text"</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">"Type of attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name_num"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</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">"Default sort order."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"has_archives"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enable/Disable attribute archives."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/attributes"</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/v1/products/attributes/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"text"</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">"Type of attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name_num"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</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">"Default sort order."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"has_archives"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enable/Disable attribute archives."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/products/categories"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"term_group"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"description"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"count"</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">"Sort collection by resource attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"hide_empty"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to hide resources not assigned to any products."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources assigned to a specific parent."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources assigned to a specific product."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources with a specific slug."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The id for the parent of the resource."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"products"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"subcategories"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"both"</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">"Category archive display type."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Image URL."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort the resource."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/categories"</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/v1/products/categories/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The id for the parent of the resource."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"products"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"subcategories"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"both"</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">"Category archive display type."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Image URL."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort the resource."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/products/categories/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The id for the parent of the resource."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"display"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"products"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"subcategories"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"both"</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">"Category archive display type."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Image URL."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort the resource."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/categories/batch"</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/v1/products/(?P<product_id>[\\d]+)/reviews"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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="nl">"/wc/v1/products/(?P<product_id>[\\d]+)/reviews/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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="nl">"/wc/v1/products/shipping_classes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"term_group"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"description"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"count"</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">"Sort collection by resource attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"hide_empty"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to hide resources not assigned to any products."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources assigned to a specific product."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources with a specific slug."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The id for the parent of the resource."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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/v1/products/shipping_classes/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping class name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The id for the parent of the resource."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/products/shipping_classes/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping class name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The id for the parent of the resource."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/shipping_classes/batch"</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/v1/products/tags"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"term_group"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"description"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"count"</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">"Sort collection by resource attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"hide_empty"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to hide resources not assigned to any products."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources assigned to a specific product."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to resources with a specific slug."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/tags"</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/v1/products/tags/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/products/tags/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"An alphanumeric identifier for the resource unique to its type."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HTML description of the resource."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/tags/batch"</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/v1/products"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"after"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published after a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"before"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published before a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"desc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to posts with a specific slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"filter"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Use WP Query arguments to modify the response; private query vars require appropriate authorization."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"any"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"any"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"draft"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"private"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"publish"</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">"Limit result set to products assigned a specific status."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"grouped"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"external"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"variable"</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">"Limit result set to products assigned a specific type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"category"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to products assigned a specific category."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tag"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to products assigned a specific tag."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to products assigned a specific shipping class."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"attribute"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to products with a specific attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"attribute_term"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to products with a specific attribute term (required an assigned attribute)."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to products with a specific SKU."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"grouped"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"external"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"variable"</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">"Product type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"draft"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"private"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"publish"</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">"Product status (post status)."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Featured product."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"catalog"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"search"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"hidden"</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">"Catalog visibility."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product description."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product short description."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Unique identifier."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product regular price."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Start date of sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"End data of sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If the product is virtual."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If the product is downloadable."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of downloadable files."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Amount of times the product can be downloaded."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Number of days that the customer has up to be able to download the product."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"application"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"music"</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">"Download type, this controls the schema on the front-end."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product external URL. Only for external products."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product external button text. Only for external products."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"shipping"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"none"</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">"Tax status."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"manage_stock"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Stock management at product level."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Stock quantity."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Controls whether or not the product is listed as </span><span class="se">\"</span><span class="s2">in stock</span><span class="se">\"</span><span class="s2"> or </span><span class="se">\"</span><span class="s2">out of stock</span><span class="se">\"</span><span class="s2"> on the frontend."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"backorders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"no"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"notify"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"yes"</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">"If managing stock, this controls if backorders are allowed."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allow one item to be bought in a single order."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product weight (kg)."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product dimensions."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping class slug."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allow reviews."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of up-sell products IDs."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of cross-sell products IDs."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product parent ID."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional note to send the customer after purchase."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of categories."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of tags."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of images."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of attributes."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Defaults variation attributes."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of variations."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort products."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products"</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/v1/products/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"grouped"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"external"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"variable"</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">"Product type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"draft"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"private"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"publish"</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">"Product status (post status)."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Featured product."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"catalog"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"search"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"hidden"</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">"Catalog visibility."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product description."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product short description."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Unique identifier."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product regular price."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Start date of sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"End data of sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If the product is virtual."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If the product is downloadable."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of downloadable files."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Amount of times the product can be downloaded."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Number of days that the customer has up to be able to download the product."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"application"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"music"</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">"Download type, this controls the schema on the front-end."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product external URL. Only for external products."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product external button text. Only for external products."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"shipping"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"none"</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">"Tax status."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"manage_stock"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Stock management at product level."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Stock quantity."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Controls whether or not the product is listed as </span><span class="se">\"</span><span class="s2">in stock</span><span class="se">\"</span><span class="s2"> or </span><span class="se">\"</span><span class="s2">out of stock</span><span class="se">\"</span><span class="s2"> on the frontend."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"backorders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"no"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"notify"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"yes"</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">"If managing stock, this controls if backorders are allowed."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allow one item to be bought in a single order."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product weight (kg)."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product dimensions."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping class slug."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allow reviews."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of up-sell products IDs."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of cross-sell products IDs."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product parent ID."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional note to send the customer after purchase."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of categories."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of tags."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of images."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of attributes."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Defaults variation attributes."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of variations."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort products."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether to bypass trash and force deletion."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"reassign"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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><span class="p">]</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"/wc/v1/products/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"simple"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"grouped"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"external"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"variable"</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">"Product type."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"draft"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"pending"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"private"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"publish"</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">"Product status (post status)."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"featured"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Featured product."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"visible"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"catalog"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"search"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"hidden"</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">"Catalog visibility."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product description."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product short description."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Unique identifier."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product regular price."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Start date of sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"End data of sale price."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"virtual"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If the product is virtual."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"downloadable"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If the product is downloadable."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of downloadable files."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Amount of times the product can be downloaded."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Number of days that the customer has up to be able to download the product."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"application"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"music"</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">"Download type, this controls the schema on the front-end."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product external URL. Only for external products."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product external button text. Only for external products."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"taxable"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"shipping"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"none"</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">"Tax status."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"manage_stock"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Stock management at product level."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Stock quantity."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Controls whether or not the product is listed as </span><span class="se">\"</span><span class="s2">in stock</span><span class="se">\"</span><span class="s2"> or </span><span class="se">\"</span><span class="s2">out of stock</span><span class="se">\"</span><span class="s2"> on the frontend."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"backorders"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"no"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"notify"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"yes"</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">"If managing stock, this controls if backorders are allowed."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allow one item to be bought in a single order."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"weight"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product weight (kg)."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product dimensions."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shipping class slug."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allow reviews."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of up-sell products IDs."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of cross-sell products IDs."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product parent ID."</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional note to send the customer after purchase."</span><span class="w">
|
|
</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of categories."</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of tags."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of images."</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="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of attributes."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Defaults variation attributes."</span><span class="w">
|
|
</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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of variations."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Menu order, used to custom sort products."</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">"_links"</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">"https://example.com/wp-json/wc/v1/products/batch"</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/v1/reports/sales"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"period"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"week"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"month"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"last_month"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"year"</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">"Report period."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_min"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Return sales for a specific start date, the date need to be in the YYYY-MM-DD format."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_max"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Return sales for a specific end date, the date need to be in the YYYY-MM-DD format."</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">"_links"</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">"https://example.com/wp-json/wc/v1/reports/sales"</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/v1/reports/top_sellers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"period"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"week"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"month"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"last_month"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"year"</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">"Report period."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_min"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Return sales for a specific start date, the date need to be in the YYYY-MM-DD format."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_max"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Return sales for a specific end date, the date need to be in the YYYY-MM-DD format."</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">"_links"</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">"https://example.com/wp-json/wc/v1/reports/top_sellers"</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/v1/reports"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</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">"Scope under which the request is made; determines fields present in response."</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">"_links"</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">"https://example.com/wp-json/wc/v1/reports"</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/v1/taxes/classes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class name."</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">"_links"</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">"https://example.com/wp-json/wc/v1/taxes/classes"</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/v1/taxes/classes/(?P<slug>\\w[\\w\\s\\-]*)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/taxes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"order"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</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="s2">"zero-rate"</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">"Sort by tax class."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Country ISO 3166 code."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"State code."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Postcode/ZIP."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"City name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax rate."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax rate name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"priority"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax priority."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether or not this is a compound rate."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether or not this tax rate also gets applied to shipping."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indicates the order that will appear in queries."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</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="s2">"zero-rate"</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">"Tax class."</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">"_links"</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">"https://example.com/wp-json/wc/v1/taxes"</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/v1/taxes/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Country ISO 3166 code."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"State code."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Postcode/ZIP."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"City name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax rate."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax rate name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"priority"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax priority."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether or not this is a compound rate."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether or not this tax rate also gets applied to shipping."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indicates the order that will appear in queries."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</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="s2">"zero-rate"</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">"Tax class."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/taxes/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"country"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Country ISO 3166 code."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"state"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"State code."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"postcode"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Postcode/ZIP."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"City name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax rate."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax rate name."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"priority"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax priority."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"compound"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether or not this is a compound rate."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Whether or not this tax rate also gets applied to shipping."</span><span class="w">
|
|
</span><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">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indicates the order that will appear in queries."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"standard"</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="s2">"zero-rate"</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">"Tax class."</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">"_links"</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">"https://example.com/wp-json/wc/v1/taxes/batch"</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/v1/webhooks/(?P<webhook_id>[\\d]+)/deliveries"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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="nl">"/wc/v1/webhooks/(?P<webhook_id>[\\d]+)/deliveries/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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="nl">"/wc/v1/webhooks"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Current page of the collection."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"per_page"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maximum number of items to be returned in result set."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"search"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit results to those matching a string."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"after"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published after a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"before"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit response to resources published before a given ISO8601 compliant date."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"exclude"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Ensure result set excludes specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"include"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"Limit result set to specific ids."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"offset"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Offset the result set by a specific number of items."</span><span class="w">
|
|
</span><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">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"desc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"asc"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"desc"</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">"Order sort attribute ascending or descending."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"orderby"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"date"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"id"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"include"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"slug"</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">"Sort collection by object attribute."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Limit result set to posts with a specific slug."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"filter"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Use WP Query arguments to modify the response; private query vars require appropriate authorization."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"all"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"all"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"paused"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"disabled"</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">"Limit result set to webhooks assigned a specific status."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A friendly name for the webhook."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"paused"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"disabled"</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">"Webhook status."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"secret"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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="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">"_links"</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">"https://example.com/wp-json/wc/v1/webhooks"</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/v1/webhooks/(?P<id>[\\d]+)"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"endpoints"</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"context"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"view"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"edit"</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">"Scope under which the request is made; determines fields present in response."</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A friendly name for the webhook."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"paused"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"disabled"</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">"Webhook status."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Webhook topic."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"secret"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided."</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">"methods"</span><span class="p">:</span><span class="w"> </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="nl">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"force"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"default"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Required to be true, as resource does not support trashing."</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="nl">"/wc/v1/webhooks/batch"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"namespace"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc/v1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"methods"</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="nl">"endpoints"</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">"methods"</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="nl">"args"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A friendly name for the webhook."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"active"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"paused"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"disabled"</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">"Webhook status."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"topic"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Webhook topic."</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"secret"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided."</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">"_links"</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">"https://example.com/wp-json/wc/v1/webhooks/batch"</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">"_links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/"</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><h1 id='coupons'>Coupons</h1>
|
|
<p>The coupons API allows you to create, view, update, and delete individual, or a batch, of coupon codes.</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>Unique identifier for the object. <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">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the coupon was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the coupon was last modified, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Coupon description.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>discount_type</code></td>
|
|
<td>string</td>
|
|
<td>Determines the type of discount that will be applied. Options: <code>fixed_cart</code>, <code>percent</code>, <code>fixed_product</code> and <code>percent_product</code>. Default: <code>fixed_cart</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>amount</code></td>
|
|
<td>string</td>
|
|
<td>The amount of discount.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>expiry_date</code></td>
|
|
<td>string</td>
|
|
<td>UTC DateTime when the coupon expires.</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>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>List of product ID's the coupon can be used on.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude_product_ids</code></td>
|
|
<td>array</td>
|
|
<td>List 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 used 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>free_shipping</code></td>
|
|
<td>boolean</td>
|
|
<td>Define if can be applied for free shipping.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_categories</code></td>
|
|
<td>array</td>
|
|
<td>List of category ID's the coupon applies to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>excluded_product_categories</code></td>
|
|
<td>array</td>
|
|
<td>List of category ID's the coupon does not apply to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude_sale_items</code></td>
|
|
<td>boolean</td>
|
|
<td>Define if should not apply when have sale items.</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>email_restrictions</code></td>
|
|
<td>array</td>
|
|
<td>List of email addresses that can use this coupon.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>used_by</code></td>
|
|
<td>array</td>
|
|
<td>List of user IDs who have used the coupon. <i class="label label-info">read-only</i></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>/wp-json/wc/v1/coupons</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/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">'{
|
|
"code": "10off",
|
|
"discount_type": "percent",
|
|
"amount": 10,
|
|
"individual_use": true,
|
|
"exclude_sale_items": true,
|
|
"minimum_amount": "100.00"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">code</span><span class="p">:</span> <span class="dl">"</span><span class="s2">10off</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">discount_type</span><span class="p">:</span> <span class="dl">"</span><span class="s2">percent</span><span class="dl">"</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="na">individual_use</span><span class="p">:</span> <span class="kc">true</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="s2">100.00</span><span class="dl">"</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="s2">coupons</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'code'</span> <span class="o">=></span> <span class="s1">'10off'</span><span class="p">,</span>
|
|
<span class="s1">'discount_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="mi">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">'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="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="nf">post</span><span class="p">(</span><span class="s1">'coupons'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"code"</span><span class="p">:</span> <span class="s">"10off"</span><span class="p">,</span>
|
|
<span class="s">"discount_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="mi">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">"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="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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">code: </span><span class="s2">"10off"</span><span class="p">,</span>
|
|
<span class="ss">discount_type: </span><span class="s2">"percent"</span><span class="p">,</span>
|
|
<span class="ss">amount: </span><span class="mi">10</span><span class="p">,</span>
|
|
<span class="ss">individual_use: </span><span class="kp">true</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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">113</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">"10off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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='retrieve-a-coupon'>Retrieve a coupon</h2>
|
|
<p>This API lets you retrieve and view a specific coupon by ID.</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>/wp-json/wc/v1/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/coupons/113 <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="s2">coupons/113</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'coupons/113'</span><span class="p">));</span> <span class="cp">?></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/113"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/113"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">113</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">"10off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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='list-all-coupons'>List all coupons</h2>
|
|
<p>This API helps you to list all the coupons that have been created.</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>/wp-json/wc/v1/coupons</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">coupons</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'coupons'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">114</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:58:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:58:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/114"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">113</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">"10off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>after</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published after a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>before</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published before a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dates_are_gmt</code></td>
|
|
<td>boolean</td>
|
|
<td>Interpret <code>after</code> and <code>before</code> as UTC dates when <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>date</code>, Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>code</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific code.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<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>/wp-json/wc/v1/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/wp-json/wc/v1/coupons/113 <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">'{
|
|
"amount": 5
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="mi">5</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="s2">coupons/113</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'amount'</span> <span class="o">=></span> <span class="mi">5</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="nf">put</span><span class="p">(</span><span class="s1">'coupons/113'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"amount"</span><span class="p">:</span> <span class="mi">5</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/113"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">amount: </span><span class="mi">5</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/113"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">113</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">"10off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T22:00:49"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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-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>/wp-json/wc/v1/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/wp-json/wc/v1/coupons/113?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="s2">coupons/113</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'coupons/113'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/113"</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 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/113"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">113</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">"10off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T22:00:49"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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-parameters-2'>Available parameters</h4>
|
|
<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, Default is <code>false</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-coupons'>Batch update coupons</h2>
|
|
<p>This API helps you to batch create, update and delete multiple coupons.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-6'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/coupons/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/coupons/batch <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">'{
|
|
"create": [
|
|
{
|
|
"code": "20off",
|
|
"discount_type": "percent",
|
|
"amount": 20,
|
|
"individual_use": true,
|
|
"exclude_sale_items": true,
|
|
"minimum_amount": "100.00"
|
|
},
|
|
{
|
|
"code": "30off",
|
|
"discount_type": "percent",
|
|
"amount": 30,
|
|
"individual_use": true,
|
|
"exclude_sale_items": true,
|
|
"minimum_amount": "100.00"
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 113,
|
|
"minimum_amount": "50.00"
|
|
}
|
|
],
|
|
"delete": [
|
|
137
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">code</span><span class="p">:</span> <span class="dl">"</span><span class="s2">20off</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">discount_type</span><span class="p">:</span> <span class="dl">"</span><span class="s2">percent</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="mi">20</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">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="s2">100.00</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">code</span><span class="p">:</span> <span class="dl">"</span><span class="s2">30off</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">discount_type</span><span class="p">:</span> <span class="dl">"</span><span class="s2">percent</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="mi">30</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">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="s2">100.00</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">113</span><span class="p">,</span>
|
|
<span class="na">minimum_amount</span><span class="p">:</span> <span class="dl">"</span><span class="s2">50.00</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">137</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="s2">customers/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'code'</span> <span class="o">=></span> <span class="s1">'20off'</span><span class="p">,</span>
|
|
<span class="s1">'discount_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="mi">20</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">'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="p">[</span>
|
|
<span class="s1">'code'</span> <span class="o">=></span> <span class="s1">'30off'</span><span class="p">,</span>
|
|
<span class="s1">'discount_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="mi">30</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">'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="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">113</span><span class="p">,</span>
|
|
<span class="s1">'minimum_amount'</span> <span class="o">=></span> <span class="s1">'50.00'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">137</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="nf">post</span><span class="p">(</span><span class="s1">'customers/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"code"</span><span class="p">:</span> <span class="s">"20off"</span><span class="p">,</span>
|
|
<span class="s">"discount_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="mi">20</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">"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="p">{</span>
|
|
<span class="s">"code"</span><span class="p">:</span> <span class="s">"30off"</span><span class="p">,</span>
|
|
<span class="s">"discount_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="mi">30</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">"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="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">113</span><span class="p">,</span>
|
|
<span class="s">"minimum_amount"</span><span class="p">:</span> <span class="s">"50.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">137</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/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">code: </span><span class="s2">"20off"</span><span class="p">,</span>
|
|
<span class="ss">discount_type: </span><span class="s2">"percent"</span><span class="p">,</span>
|
|
<span class="ss">amount: </span><span class="mi">20</span><span class="p">,</span>
|
|
<span class="ss">individual_use: </span><span class="kp">true</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="p">{</span>
|
|
<span class="ss">code: </span><span class="s2">"30off"</span><span class="p">,</span>
|
|
<span class="ss">discount_type: </span><span class="s2">"percent"</span><span class="p">,</span>
|
|
<span class="ss">amount: </span><span class="mi">30</span><span class="p">,</span>
|
|
<span class="ss">individual_use: </span><span class="kp">true</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="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">113</span><span class="p">,</span>
|
|
<span class="ss">minimum_amount: </span><span class="s2">"50.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">137</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/batch"</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">"create"</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">138</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">"20off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:52:21"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:52:21"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"amount"</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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/138"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">139</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">"30off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:52:22"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:52:22"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"amount"</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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/139"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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="nl">"update"</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">113</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">"10off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-04-28T21:55:54"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:52:23"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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="nl">"delete"</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">137</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">"50off"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:49:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-17T20:50:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"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">"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">"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">"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">"individual_use"</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_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">"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_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"excluded_product_categories"</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">false</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">"0.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">"email_restrictions"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"used_by"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons/137"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/coupons"</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><h1 id='customers'>Customers</h1>
|
|
<p>The customer API allows you to create, view, update, and delete individual, or a batch, of customers.</p>
|
|
<h2 id='customer-properties'>Customer 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the customer was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the customer was last modified, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>email</code></td>
|
|
<td>string</td>
|
|
<td>The email address for the customer. <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 login name. Can be generated automatically from the customer's email address if the option <code>woocommerce_registration_generate_username</code> is equal to <code>yes</code> <i class="label label-info">cannot be changed</i> <i class="label label-info">maybe mandatory</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> <i class="label label-info">maybe mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>last_order</code></td>
|
|
<td>array</td>
|
|
<td>Last order data. See <a href="#customer-last-order-properties">Customer Last Order properties</a>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orders_count</code></td>
|
|
<td>integer</td>
|
|
<td>Quantity of orders made by the customer. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_spent</code></td>
|
|
<td>string</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>Avatar URL.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>billing</code></td>
|
|
<td>array</td>
|
|
<td>List of billing address data. See <a href="#billing-address-properties">Billing Address properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping</code></td>
|
|
<td>array</td>
|
|
<td>List of shipping address data. See <a href="#shipping-address-properties">Shipping Address properties</a>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='customer-last-order-properties'>Customer last order 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>Last order ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date</code></td>
|
|
<td>date-time</td>
|
|
<td>UTC DateTime of the customer last order. <i class="label label-info">read-only</i></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 number.</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>/wp-json/wc/v1/customers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/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">'{
|
|
"email": "john.doe@example.com",
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"username": "john.doe",
|
|
"billing": {
|
|
"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": {
|
|
"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">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="s2">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="s2">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="s2">john.doe</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">(555) 555-5555</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">US</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="s2">customers</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="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'</span> <span class="o">=></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'</span> <span class="o">=></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="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="nf">post</span><span class="p">(</span><span class="s1">'customers'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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"</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"</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="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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</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: </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: </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="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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:58:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:34:43"</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"</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">118</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">"2016-05-03T18:10:43"</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="mi">3</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">"28.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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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='retrieve-a-customer'>Retrieve a customer</h2>
|
|
<p>This API lets you retrieve and view a specific customer by ID.</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>/wp-json/wc/v1/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">customers/2</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'customers/2'</span><span class="p">));</span> <span class="cp">?></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 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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:58:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:34:43"</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"</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">118</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">"2016-05-03T18:10:43"</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="mi">3</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">"28.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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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='list-all-customers'>List all 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>/wp-json/wc/v1/customers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">customers</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'customers'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:39:01"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:40:02"</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"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</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="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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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="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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:58:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:34:43"</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"</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">118</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">"2016-05-03T18:10:43"</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="mi">3</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">"28.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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>, Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>name</code>. Options: <code>id</code>, <code>include</code>, <code>name</code> and <code>registered_date</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>email</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific email.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>role</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific role. Default: <code>customer</code>. Options (some plugins can add more user roles): <code>all</code>, <code>administrator</code>, <code>editor</code>, <code>author</code>, <code>contributor</code>, <code>subscriber</code>, <code>customer</code> and <code>shop_manager</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>/wp-json/wc/v1/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/wp-json/wc/v1/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">'{
|
|
"first_name": "James",
|
|
"billing": {
|
|
"first_name": "James"
|
|
},
|
|
"shipping": {
|
|
"first_name": "James"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">first_name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">James</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">James</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">James</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="s2">customers/2</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="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'</span> <span class="o">=></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'</span> <span class="o">=></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="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="nf">put</span><span class="p">(</span><span class="s1">'customers/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 python tab-python"><code><span class="n">data</span> <span class="o">=</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"</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"</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="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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"James"</span><span class="p">,</span>
|
|
<span class="ss">billing: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"James"</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">shipping: </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="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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:58:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:43:45"</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"</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">118</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">"2016-05-03T18:10:43"</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="mi">3</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">"28.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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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">"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">"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"</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">"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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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-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>/wp-json/wc/v1/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/wp-json/wc/v1/customers/2?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="s2">customers/2</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'customers/2'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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">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 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="ss">force: </span><span class="kp">true</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:58:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:43:45"</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"</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">118</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">"2016-05-03T18:10:43"</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="mi">3</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">"28.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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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">"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">"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"</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">"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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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-parameters-2'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-customers'>Batch update customers</h2>
|
|
<p>This API helps you to batch create, update and delete multiple customers.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-6'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/customers/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/customers/batch <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">'{
|
|
"create": [
|
|
{
|
|
"email": "john.doe2@example.com",
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"username": "john.doe2",
|
|
"billing": {
|
|
"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": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"company": "",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US"
|
|
}
|
|
},
|
|
{
|
|
"email": "joao.silva2@example.com",
|
|
"first_name": "João",
|
|
"last_name": "Silva",
|
|
"username": "joao.silva2",
|
|
"billing": {
|
|
"first_name": "João",
|
|
"last_name": "Silva",
|
|
"company": "",
|
|
"address_1": "Av. Brasil, 432",
|
|
"address_2": "",
|
|
"city": "Rio de Janeiro",
|
|
"state": "RJ",
|
|
"postcode": "12345-000",
|
|
"country": "BR",
|
|
"email": "joao.silva@example.com",
|
|
"phone": "(55) 5555-5555"
|
|
},
|
|
"shipping": {
|
|
"first_name": "João",
|
|
"last_name": "Silva",
|
|
"company": "",
|
|
"address_1": "Av. Brasil, 432",
|
|
"address_2": "",
|
|
"city": "Rio de Janeiro",
|
|
"state": "RJ",
|
|
"postcode": "12345-000",
|
|
"country": "BR"
|
|
}
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 5,
|
|
"billing": {
|
|
"phone": "(11) 1111-1111"
|
|
}
|
|
}
|
|
],
|
|
"delete": [
|
|
2
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">"</span><span class="s2">john.doe2@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="s2">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="s2">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="s2">john.doe2</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">(555) 555-5555</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">US</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">"</span><span class="s2">joao.silva2@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="s2">João</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="s2">Silva</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">username</span><span class="p">:</span> <span class="dl">"</span><span class="s2">joao.silva2</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">João</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="s2">Silva</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="s2">Av. Brasil, 432</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="s2">Rio de Janeiro</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">RJ</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">postcode</span><span class="p">:</span> <span class="dl">"</span><span class="s2">12345-000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">BR</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">email</span><span class="p">:</span> <span class="dl">"</span><span class="s2">joao.silva@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="s2">(55) 5555-5555</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">João</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="s2">Silva</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="s2">Av. Brasil, 432</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="s2">Rio de Janeiro</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">RJ</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">postcode</span><span class="p">:</span> <span class="dl">"</span><span class="s2">12345-000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">BR</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
|
|
<span class="na">billing</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">phone</span><span class="p">:</span> <span class="dl">"</span><span class="s2">(11) 1111-1111</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">2</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="s2">customers/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john.doe2@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.doe2'</span><span class="p">,</span>
|
|
<span class="s1">'billing'</span> <span class="o">=></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'</span> <span class="o">=></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="s1">'email'</span> <span class="o">=></span> <span class="s1">'joao.silva2@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'João'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Silva'</span><span class="p">,</span>
|
|
<span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'joao.silva2'</span><span class="p">,</span>
|
|
<span class="s1">'billing'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'João'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Silva'</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">'Av. Brasil, 432'</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">'Rio de Janeiro'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'RJ'</span><span class="p">,</span>
|
|
<span class="s1">'postcode'</span> <span class="o">=></span> <span class="s1">'12345-000'</span><span class="p">,</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'BR'</span><span class="p">,</span>
|
|
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'joao.silva@example.com'</span><span class="p">,</span>
|
|
<span class="s1">'phone'</span> <span class="o">=></span> <span class="s1">'(55) 5555-5555'</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="s1">'first_name'</span> <span class="o">=></span> <span class="s1">'João'</span><span class="p">,</span>
|
|
<span class="s1">'last_name'</span> <span class="o">=></span> <span class="s1">'Silva'</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">'Av. Brasil, 432'</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">'Rio de Janeiro'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'RJ'</span><span class="p">,</span>
|
|
<span class="s1">'postcode'</span> <span class="o">=></span> <span class="s1">'12345-000'</span><span class="p">,</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'BR'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">5</span><span class="p">,</span>
|
|
<span class="s1">'billing'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="s1">'phone'</span> <span class="o">=></span> <span class="s1">'(11) 1111-1111'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">2</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="nf">post</span><span class="p">(</span><span class="s1">'customers/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe2@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.doe2"</span><span class="p">,</span>
|
|
<span class="s">"billing"</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"</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="s">"email"</span><span class="p">:</span> <span class="s">"joao.silva2@example.com"</span><span class="p">,</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"João"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Silva"</span><span class="p">,</span>
|
|
<span class="s">"username"</span><span class="p">:</span> <span class="s">"joao.silva2"</span><span class="p">,</span>
|
|
<span class="s">"billing"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"João"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Silva"</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">"Av. Brasil, 432"</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">"Rio de Janeiro"</span><span class="p">,</span>
|
|
<span class="s">"state"</span><span class="p">:</span> <span class="s">"RJ"</span><span class="p">,</span>
|
|
<span class="s">"postcode"</span><span class="p">:</span> <span class="s">"12345-000"</span><span class="p">,</span>
|
|
<span class="s">"country"</span><span class="p">:</span> <span class="s">"BR"</span><span class="p">,</span>
|
|
<span class="s">"email"</span><span class="p">:</span> <span class="s">"joao.silva@example.com"</span><span class="p">,</span>
|
|
<span class="s">"phone"</span><span class="p">:</span> <span class="s">"(55) 5555-5555"</span>
|
|
<span class="p">},</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"first_name"</span><span class="p">:</span> <span class="s">"João"</span><span class="p">,</span>
|
|
<span class="s">"last_name"</span><span class="p">:</span> <span class="s">"Silva"</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">"Av. Brasil, 432"</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">"Rio de Janeiro"</span><span class="p">,</span>
|
|
<span class="s">"state"</span><span class="p">:</span> <span class="s">"RJ"</span><span class="p">,</span>
|
|
<span class="s">"postcode"</span><span class="p">:</span> <span class="s">"12345-000"</span><span class="p">,</span>
|
|
<span class="s">"country"</span><span class="p">:</span> <span class="s">"BR"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
|
|
<span class="s">"billing"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"phone"</span><span class="p">:</span> <span class="s">"(11) 1111-1111"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">2</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/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">email: </span><span class="s2">"john.doe2@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.doe2"</span><span class="p">,</span>
|
|
<span class="ss">billing: </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: </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="ss">email: </span><span class="s2">"joao.silva2@example.com"</span><span class="p">,</span>
|
|
<span class="ss">first_name: </span><span class="s2">"João"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Silva"</span><span class="p">,</span>
|
|
<span class="ss">username: </span><span class="s2">"joao.silva2"</span><span class="p">,</span>
|
|
<span class="ss">billing: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"João"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Silva"</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">"Av. Brasil, 432"</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">"Rio de Janeiro"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"RJ"</span><span class="p">,</span>
|
|
<span class="ss">postcode: </span><span class="s2">"12345-000"</span><span class="p">,</span>
|
|
<span class="ss">country: </span><span class="s2">"BR"</span><span class="p">,</span>
|
|
<span class="ss">email: </span><span class="s2">"joao.silva@example.com"</span><span class="p">,</span>
|
|
<span class="ss">phone: </span><span class="s2">"(55) 5555-5555"</span>
|
|
<span class="p">},</span>
|
|
<span class="ss">shipping: </span><span class="p">{</span>
|
|
<span class="ss">first_name: </span><span class="s2">"João"</span><span class="p">,</span>
|
|
<span class="ss">last_name: </span><span class="s2">"Silva"</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">"Av. Brasil, 432"</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">"Rio de Janeiro"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"RJ"</span><span class="p">,</span>
|
|
<span class="ss">postcode: </span><span class="s2">"12345-000"</span><span class="p">,</span>
|
|
<span class="ss">country: </span><span class="s2">"BR"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">5</span><span class="p">,</span>
|
|
<span class="ss">billing: </span><span class="p">{</span>
|
|
<span class="ss">phone: </span><span class="s2">"(11) 1111-1111"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">2</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/batch"</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">"create"</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">6</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T22:06:32"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T22:07:31"</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.doe2@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.doe2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</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="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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T22:07:33"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T22:07:37"</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.silva2@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.silva2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"last_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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</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="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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/7"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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="nl">"update"</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">5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:39:01"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T22:04:36"</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"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</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="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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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">"(11) 1111-1111"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"shipping"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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="nl">"delete"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:58:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-11T21:43:45"</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"</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">118</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">"2016-05-03T18:10:43"</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="mi">3</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">"28.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/?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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">"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">"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"</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">"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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers"</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><h2 id='retrieve-customer-downloads'>Retrieve customer downloads</h2>
|
|
<p>This API lets you retrieve customer downloads permissions.</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>/wp-json/wc/v1/customers/<id>/downloads</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">customers/2/downloads</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'customers/2/downloads'</span><span class="p">));</span> <span class="cp">?></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 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="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_571a7260c0da5&email=john.dow@xanmple.com&key=1789931e0c14ad9909a50c826f10c169"</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">"1789931e0c14ad9909a50c826f10c169"</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; Testing"</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">105</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_571a7260c0da5"</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">"unlimited"</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="s2">"never"</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">"Testing"</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/2013/06/cd_5_angle.jpg"</span><span class="w">
|
|
</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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/1/downloads"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/96"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/105"</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><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. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_id</code></td>
|
|
<td>string</td>
|
|
<td>Download ID (MD5). <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_id</code></td>
|
|
<td>integer</td>
|
|
<td>Downloadable product ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_name</code></td>
|
|
<td>string</td>
|
|
<td>Downloadable file name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_id</code></td>
|
|
<td>integer</td>
|
|
<td>Order ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_key</code></td>
|
|
<td>string</td>
|
|
<td>Order key. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads_remaining</code></td>
|
|
<td>string</td>
|
|
<td>Amount of downloads remaining. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>access_expires</code></td>
|
|
<td>string</td>
|
|
<td>The date when the download access expires, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file</code></td>
|
|
<td>array</td>
|
|
<td>File details with <code>name</code> (file name) and <code>file</code> (file URL) attributes. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h1 id='orders'>Orders</h1>
|
|
<p>The orders API allows you to create, view, update, and delete individual, or a batch, of orders.</p>
|
|
<h2 id='order-properties'>Order 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_id</code></td>
|
|
<td>integer</td>
|
|
<td>Parent order ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Order status. Default is <code>pending</code>. Options (plugins may include new status): <code>pending</code>, <code>processing</code>, <code>on-hold</code>, <code>completed</code>, <code>cancelled</code>, <code>refunded</code> and <code>failed</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_key</code></td>
|
|
<td>string</td>
|
|
<td>Order key. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>number</code></td>
|
|
<td>string</td>
|
|
<td>Order number. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency</code></td>
|
|
<td>string</td>
|
|
<td>Currency the order was created with, in ISO format, e.g <code>USD</code>. Default is the current store currency.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>version</code></td>
|
|
<td>string</td>
|
|
<td>Version of WooCommerce when the order was made. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>prices_include_tax</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the prices included tax during checkout. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was last modified, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_id</code></td>
|
|
<td>integer</td>
|
|
<td>User ID who owns the order. Use <code>0</code> for guests. Default is <code>0</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>discount_total</code></td>
|
|
<td>string</td>
|
|
<td>Total discount amount for the order. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>discount_tax</code></td>
|
|
<td>string</td>
|
|
<td>Total discount tax amount for the order. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_total</code></td>
|
|
<td>string</td>
|
|
<td>Total shipping amount for the order. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_tax</code></td>
|
|
<td>string</td>
|
|
<td>Total shipping tax amount for the order. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>cart_tax</code></td>
|
|
<td>string</td>
|
|
<td>Sum of line item taxes only. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Grand total. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Sum of all taxes. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>billing</code></td>
|
|
<td>object</td>
|
|
<td>Billing address. See <a href="#billing-address-properties">Customer Billing Address properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping</code></td>
|
|
<td>object</td>
|
|
<td>Shipping address. See <a href="#shipping-address-properties">Customer Shipping Address properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>payment_method</code></td>
|
|
<td>string</td>
|
|
<td>Payment method ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>payment_method_title</code></td>
|
|
<td>string</td>
|
|
<td>Payment method title.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>set_paid</code></td>
|
|
<td>boolean</td>
|
|
<td>Define if the order is paid. It will set the status to processing and reduce stock items. Default is <code>false</code>. <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>transaction_id</code></td>
|
|
<td>string</td>
|
|
<td>Unique transaction ID. In write-mode only is available if <code>set_paid</code> is <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_ip_address</code></td>
|
|
<td>string</td>
|
|
<td>Customer's IP address. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_user_agent</code></td>
|
|
<td>string</td>
|
|
<td>User agent of the customer. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>created_via</code></td>
|
|
<td>string</td>
|
|
<td>Shows where the order was created. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_note</code></td>
|
|
<td>string</td>
|
|
<td>Note left by customer during checkout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_completed</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was completed, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_paid</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order has been paid, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>cart_hash</code></td>
|
|
<td>string</td>
|
|
<td>MD5 hash of cart items to ensure orders are not modified. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>line_items</code></td>
|
|
<td>array</td>
|
|
<td>Line items data. See <a href="#line-item-properties">Line Items properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_lines</code></td>
|
|
<td>array</td>
|
|
<td>Tax lines data. See <a href="#tax-line-properties">Tax Lines properties</a>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_lines</code></td>
|
|
<td>array</td>
|
|
<td>Shipping lines data. See <a href="#shipping-line-properties">Shipping Lines properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fee_lines</code></td>
|
|
<td>array</td>
|
|
<td>Fee lines data. See <a href="#fee-line-properties">Fee Lines Properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>coupon_lines</code></td>
|
|
<td>array</td>
|
|
<td>Coupons line data. See <a href="#coupon-line-properties">Coupon Lines properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>refunds</code></td>
|
|
<td>array</td>
|
|
<td>List of refunds. See <a href="#refunds-line-properties">Refunds Lines properties</a>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='line-item-properties'>Line item 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>Item ID. <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>sku</code></td>
|
|
<td>string</td>
|
|
<td>Product SKU. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_id</code></td>
|
|
<td>integer</td>
|
|
<td>Product ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variation_id</code></td>
|
|
<td>integer</td>
|
|
<td>Variation ID, if applicable.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Quantity ordered.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class of product. <i class="label label-info">read-only</i></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>subtotal</code></td>
|
|
<td>string</td>
|
|
<td>Line subtotal (before discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subtotal_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line subtotal tax (before discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Line total (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line total tax (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxes</code></td>
|
|
<td>array</td>
|
|
<td>Line taxes with <code>id</code>, <code>total</code> and <code>subtotal</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta</code></td>
|
|
<td>array</td>
|
|
<td>Line item meta data with <code>key</code>, <code>label</code> and <code>value</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='tax-line-properties'>Tax line 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>Item ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rate_code</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate code. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rate_id</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>label</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate label. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>compound</code></td>
|
|
<td>boolean</td>
|
|
<td>Show if is a compound tax rate. Compound tax rates are applied on top of other tax rates. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_total</code></td>
|
|
<td>string</td>
|
|
<td>Tax total (not including shipping taxes). <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_tax_total</code></td>
|
|
<td>string</td>
|
|
<td>Shipping tax total. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='shipping-line-properties'>Shipping line 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>Item ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_title</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method name.</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>total</code></td>
|
|
<td>string</td>
|
|
<td>Line total (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line total tax (after discounts). <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxes</code></td>
|
|
<td>array</td>
|
|
<td>Line taxes with <code>id</code> and <code>total</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='fee-line-properties'>Fee line 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>Item ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Fee name. <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class. <i class="label label-info">required if the fee is taxable</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status of fee. Set to <code>taxable</code> if need apply taxes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Line total (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line total tax (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxes</code></td>
|
|
<td>array</td>
|
|
<td>Line taxes with <code>id</code>, <code>total</code> and <code>subtotal</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='coupon-line-properties'>Coupon line 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>Item 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>discount</code></td>
|
|
<td>string</td>
|
|
<td>Discount total. <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>discount_tax</code></td>
|
|
<td>string</td>
|
|
<td>Discount total tax. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='refund-line-properties'>Refund line 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>Refund ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reason</code></td>
|
|
<td>string</td>
|
|
<td>Refund reason. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Refund total. <i class="label label-info">read-only</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>/wp-json/wc/v1/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/wp-json/wc/v1/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">'{
|
|
"payment_method": "bacs",
|
|
"payment_method_title": "Direct Bank Transfer",
|
|
"set_paid": true,
|
|
"billing": {
|
|
"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": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US"
|
|
},
|
|
"line_items": [
|
|
{
|
|
"product_id": 93,
|
|
"quantity": 2
|
|
},
|
|
{
|
|
"product_id": 22,
|
|
"variation_id": 23,
|
|
"quantity": 1
|
|
}
|
|
],
|
|
"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">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">payment_method</span><span class="p">:</span> <span class="dl">"</span><span class="s2">bacs</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">payment_method_title</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Direct Bank Transfer</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">set_paid</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">(555) 555-5555</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">US</span><span class="dl">"</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">93</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">22</span><span class="p">,</span>
|
|
<span class="na">variation_id</span><span class="p">:</span> <span class="mi">23</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="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="s2">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="s2">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="s2">10.00</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="s2">orders</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'payment_method'</span> <span class="o">=></span> <span class="s1">'bacs'</span><span class="p">,</span>
|
|
<span class="s1">'payment_method_title'</span> <span class="o">=></span> <span class="s1">'Direct Bank Transfer'</span><span class="p">,</span>
|
|
<span class="s1">'set_paid'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'billing'</span> <span class="o">=></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'</span> <span class="o">=></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">'line_items'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">93</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="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="s1">'variation_id'</span> <span class="o">=></span> <span class="mi">23</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="p">],</span>
|
|
<span class="s1">'shipping_lines'</span> <span class="o">=></span> <span class="p">[</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="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="nf">post</span><span class="p">(</span><span class="s1">'orders'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"payment_method"</span><span class="p">:</span> <span class="s">"bacs"</span><span class="p">,</span>
|
|
<span class="s">"payment_method_title"</span><span class="p">:</span> <span class="s">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="s">"set_paid"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"billing"</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"</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">"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">93</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">22</span><span class="p">,</span>
|
|
<span class="s">"variation_id"</span><span class="p">:</span> <span class="mi">23</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="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="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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">payment_method: </span><span class="s2">"bacs"</span><span class="p">,</span>
|
|
<span class="ss">payment_method_title: </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="ss">set_paid: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">billing: </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: </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">line_items: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">93</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">22</span><span class="p">,</span>
|
|
<span class="ss">variation_id: </span><span class="mi">23</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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='retrieve-an-order'>Retrieve 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>/wp-json/wc/v1/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/orders/154 <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="s2">orders/154</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'orders/154'</span><span class="p">));</span> <span class="cp">?></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/154"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/154"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>dp</code></td>
|
|
<td>string</td>
|
|
<td>Number of decimal points to use in each resource.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='list-all-orders'>List all 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>/wp-json/wc/v1/orders</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">orders</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'orders'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">116</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_5728e6e53d2a4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"116"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T17:59:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:37:31"</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">1</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"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">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"14.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">"billing"</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@claudiosmweb.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"</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">"payment_method"</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">"payment_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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</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_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">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03 14:59:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">6</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 Single #2"</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">"12345"</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">99</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"2.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">"4.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">"4.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">"taxes"</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="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">"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">7</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/customers/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><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span></code></pre></div><h4 id='available-parameters-2'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>after</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published after a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>before</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published before a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dates_are_gmt</code></td>
|
|
<td>boolean</td>
|
|
<td>Interpret <code>after</code> and <code>before</code> as UTC dates when <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>date</code>, Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to orders assigned a specific status. Default is <code>any</code>. Options (plugins may add new status): <code>any</code>, <code>pending</code>, <code>processing</code>, <code>on-hold</code>, <code>completed</code>, <code>cancelled</code>, <code>refunded</code> and <code>failed</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to orders assigned a specific customer.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to orders assigned a specific product.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dp</code></td>
|
|
<td>string</td>
|
|
<td>Number of decimal points to use in each resource.</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>/wp-json/wc/v1/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/wp-json/wc/v1/orders/154 <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">'{
|
|
"status": "completed"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">status</span><span class="p">:</span> <span class="dl">"</span><span class="s2">completed</span><span class="dl">"</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="s2">orders/154</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'status'</span> <span class="o">=></span> <span class="s1">'completed'</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="nf">put</span><span class="p">(</span><span class="s1">'orders/154'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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="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/154"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">status: </span><span class="s2">"completed"</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/154"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:46:16"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:47:46"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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>/wp-json/wc/v1/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/wp-json/wc/v1/orders/154?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="s2">orders/154</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'orders/154'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/154"</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 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/154"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:46:16"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:47:46"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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-parameters-3'>Available parameters</h4>
|
|
<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, Default is <code>false</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-orders'>Batch update orders</h2>
|
|
<p>This API helps you to batch create, update and delete multiple orders.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-6'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/orders/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/orders/batch <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">'{
|
|
"create": [
|
|
{
|
|
"payment_method": "bacs",
|
|
"payment_method_title": "Direct Bank Transfer",
|
|
"billing": {
|
|
"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": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US"
|
|
},
|
|
"line_items": [
|
|
{
|
|
"product_id": 79,
|
|
"quantity": 1
|
|
},
|
|
{
|
|
"product_id": 93,
|
|
"quantity": 1
|
|
},
|
|
{
|
|
"product_id": 22,
|
|
"variation_id": 23,
|
|
"quantity": 1
|
|
}
|
|
],
|
|
"shipping_lines": [
|
|
{
|
|
"method_id": "flat_rate",
|
|
"method_title": "Flat Rate",
|
|
"total": "30.00"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"payment_method": "bacs",
|
|
"payment_method_title": "Direct Bank Transfer",
|
|
"set_paid": true,
|
|
"billing": {
|
|
"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": {
|
|
"first_name": "John",
|
|
"last_name": "Doe",
|
|
"address_1": "969 Market",
|
|
"address_2": "",
|
|
"city": "San Francisco",
|
|
"state": "CA",
|
|
"postcode": "94103",
|
|
"country": "US"
|
|
},
|
|
"line_items": [
|
|
{
|
|
"product_id": 22,
|
|
"variation_id": 23,
|
|
"quantity": 1
|
|
},
|
|
{
|
|
"product_id": 22,
|
|
"variation_id": 24,
|
|
"quantity": 1
|
|
}
|
|
],
|
|
"shipping_lines": [
|
|
{
|
|
"method_id": "flat_rate",
|
|
"method_title": "Flat Rate",
|
|
"total": "20.00"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 154,
|
|
"shipping_methods": "Local Delivery"
|
|
}
|
|
],
|
|
"delete": [
|
|
154
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">payment_method</span><span class="p">:</span> <span class="dl">"</span><span class="s2">bacs</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">payment_method_title</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Direct Bank Transfer</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">(555) 555-5555</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">US</span><span class="dl">"</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">79</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="p">{</span>
|
|
<span class="na">product_id</span><span class="p">:</span> <span class="mi">93</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="p">{</span>
|
|
<span class="na">product_id</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="na">variation_id</span><span class="p">:</span> <span class="mi">23</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="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="s2">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="s2">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="s2">30.00</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">payment_method</span><span class="p">:</span> <span class="dl">"</span><span class="s2">bacs</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">payment_method_title</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Direct Bank Transfer</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">set_paid</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">billing</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">(555) 555-5555</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="na">shipping</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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">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="s2">US</span><span class="dl">"</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">22</span><span class="p">,</span>
|
|
<span class="na">variation_id</span><span class="p">:</span> <span class="mi">23</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="p">{</span>
|
|
<span class="na">product_id</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="na">variation_id</span><span class="p">:</span> <span class="mi">24</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="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="s2">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="s2">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="s2">20.00</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">154</span><span class="p">,</span>
|
|
<span class="na">shipping_methods</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Local Delivery</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">154</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="s2">orders/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'payment_method'</span> <span class="o">=></span> <span class="s1">'bacs'</span><span class="p">,</span>
|
|
<span class="s1">'payment_method_title'</span> <span class="o">=></span> <span class="s1">'Direct Bank Transfer'</span><span class="p">,</span>
|
|
<span class="s1">'billing'</span> <span class="o">=></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'</span> <span class="o">=></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">'line_items'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">79</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="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">93</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="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="s1">'variation_id'</span> <span class="o">=></span> <span class="mi">23</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="p">],</span>
|
|
<span class="s1">'shipping_lines'</span> <span class="o">=></span> <span class="p">[</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">'30.00'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'payment_method'</span> <span class="o">=></span> <span class="s1">'bacs'</span><span class="p">,</span>
|
|
<span class="s1">'payment_method_title'</span> <span class="o">=></span> <span class="s1">'Direct Bank Transfer'</span><span class="p">,</span>
|
|
<span class="s1">'set_paid'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'billing'</span> <span class="o">=></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'</span> <span class="o">=></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">'line_items'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="s1">'variation_id'</span> <span class="o">=></span> <span class="mi">23</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="p">[</span>
|
|
<span class="s1">'product_id'</span> <span class="o">=></span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="s1">'variation_id'</span> <span class="o">=></span> <span class="mi">24</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="p">],</span>
|
|
<span class="s1">'shipping_lines'</span> <span class="o">=></span> <span class="p">[</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">'20.00'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">154</span><span class="p">,</span>
|
|
<span class="s1">'shipping_methods'</span> <span class="o">=></span> <span class="s1">'Local Delivery'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">154</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="nf">post</span><span class="p">(</span><span class="s1">'orders/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"payment_method"</span><span class="p">:</span> <span class="s">"bacs"</span><span class="p">,</span>
|
|
<span class="s">"payment_method_title"</span><span class="p">:</span> <span class="s">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="s">"billing"</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"</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">"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">79</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="p">{</span>
|
|
<span class="s">"product_id"</span><span class="p">:</span> <span class="mi">93</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="p">{</span>
|
|
<span class="s">"product_id"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="s">"variation_id"</span><span class="p">:</span> <span class="mi">23</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="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">"30.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"payment_method"</span><span class="p">:</span> <span class="s">"bacs"</span><span class="p">,</span>
|
|
<span class="s">"payment_method_title"</span><span class="p">:</span> <span class="s">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="s">"set_paid"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"billing"</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"</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">"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">22</span><span class="p">,</span>
|
|
<span class="s">"variation_id"</span><span class="p">:</span> <span class="mi">23</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="p">{</span>
|
|
<span class="s">"product_id"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
|
|
<span class="s">"variation_id"</span><span class="p">:</span> <span class="mi">24</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="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">"20.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">154</span><span class="p">,</span>
|
|
<span class="s">"shipping_methods"</span><span class="p">:</span> <span class="s">"Local Delivery"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">154</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/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">payment_method: </span><span class="s2">"bacs"</span><span class="p">,</span>
|
|
<span class="ss">payment_method_title: </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="ss">billing: </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: </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">line_items: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">79</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">93</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">22</span><span class="p">,</span>
|
|
<span class="ss">variation_id: </span><span class="mi">23</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</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">"30.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">payment_method: </span><span class="s2">"bacs"</span><span class="p">,</span>
|
|
<span class="ss">payment_method_title: </span><span class="s2">"Direct Bank Transfer"</span><span class="p">,</span>
|
|
<span class="ss">set_paid: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">billing: </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: </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">line_items: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">22</span><span class="p">,</span>
|
|
<span class="ss">variation_id: </span><span class="mi">23</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">product_id: </span><span class="mi">22</span><span class="p">,</span>
|
|
<span class="ss">variation_id: </span><span class="mi">24</span><span class="p">,</span>
|
|
<span class="ss">quantity: </span><span class="mi">1</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">"20.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">154</span><span class="p">,</span>
|
|
<span class="ss">shipping_methods: </span><span class="s2">"Local Delivery"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">154</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/batch"</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">"create"</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">155</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">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</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_574cc9541cea3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"155"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T23:14:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T23:14:28"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.85"</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">"70.85"</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.85"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T20:14:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">22</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 Logo"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">79</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"15.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">"15.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">"1.13"</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">"15.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">"1.13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.125</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.125</span><span class="w">
|
|
</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="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">23</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"3.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.23"</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">"3.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.23"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.225</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.225</span><span class="w">
|
|
</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="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">24</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">26</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.85"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">25</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">"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">"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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/155"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">156</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc95465214"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"156"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T23:14:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T23:14:28"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.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">"63.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">"3.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T20:14:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 20:14:37"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">27</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">24</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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="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">30</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">29</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">"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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/156"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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="nl">"update"</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">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:55:19"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:47:46"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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="nl">"delete"</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">154</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">"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">"order_key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wc_order_574cc02467274"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"154"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"prices_include_tax"</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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:35:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T22:55:19"</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"discount_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">"discount_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_total"</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">"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">"cart_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</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">"37.95"</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.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"billing"</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"</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">"payment_method"</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">"payment_method_title"</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">"transaction_id"</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_address"</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">"curl/7.47.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"created_via"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rest-api"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T19:47:46"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30 19:35:25"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"cart_hash"</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">18</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 Single #1"</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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"3.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">"6.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">"6.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">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.45</span><span class="w">
|
|
</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="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">19</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">"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">"product_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">""</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">"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">"1.50"</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">"1.50"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</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">75</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.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">"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">"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">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate_code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"US-CA-STATE TAX"</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">"75"</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">"State Tax"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.95"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shipping_tax_total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"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">20</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">"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">"total"</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">"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">"taxes"</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">"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">"refunds"</span><span class="p">:</span><span class="w"> </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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/154"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders"</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><h1 id='order-notes'>Order notes</h1>
|
|
<p>The order notes API allows you to create, view, and delete individual order notes.<br>
|
|
Order notes are added by administrators and programmatically to store data about an order, or order events.</p>
|
|
<h2 id='order-note-properties'>Order note 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order note was created, in the site's timezone. <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='create-an-order-note'>Create an order note</h2>
|
|
<p>This API helps you to create a new note for an 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>/wp-json/wc/v1/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/wp-json/wc/v1/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">'{
|
|
"note": "Order ok!!!"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">note</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Order ok!!!</span><span class="dl">"</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="s2">orders/645/notes</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'note'</span> <span class="o">=></span> <span class="s1">'Order ok!!!'</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="nf">post</span><span class="p">(</span><span class="s1">'orders/645/notes'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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="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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">note: </span><span class="s2">"Order ok!!!"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">51</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-13T20:51:55"</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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes/51"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118"</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='retrieve-an-order-note'>Retrieve an order note</h2>
|
|
<p>This API lets you retrieve and view a specific note from an 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>/wp-json/wc/v1/orders/<id>/notes/<note_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/orders/645/notes/51 <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="s2">orders/645/notes/51</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'orders/645/notes/51'</span><span class="p">));</span> <span class="cp">?></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/51"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/51"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">51</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-13T20:51:55"</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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes/51"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118"</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='list-all-order-notes'>List all order notes</h2>
|
|
<p>This API helps you to view all the notes from an order.</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>/wp-json/wc/v1/orders/<id>/notes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">orders/645/notes</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'orders/645/notes'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">51</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-13T20:51:55"</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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes/51"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">46</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-03T18:10:43"</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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes/46"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118"</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><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-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/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/wp-json/wc/v1/orders/645/notes/51?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="s2">orders/645/notes/51</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'orders/645/notes/51'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/51"</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 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/51"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">51</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-13T20:51:55"</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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes/51"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118/notes"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/118"</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-parameters'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h1 id='refunds'>Refunds</h1>
|
|
<p>The refunds API allows you to create, view, and delete individual refunds.</p>
|
|
<h2 id='refund-properties'>Refund 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order refund was created, in the site's timezone. <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>Line items data. See <a href="#refund-line-item-properties">Refunds Line Items properties</a>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='refund-line-item-properties'>Refund line item 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>Item ID. <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>sku</code></td>
|
|
<td>string</td>
|
|
<td>Product SKU. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_id</code></td>
|
|
<td>integer</td>
|
|
<td>Product ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variation_id</code></td>
|
|
<td>integer</td>
|
|
<td>Variation ID, if applicable.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Quantity ordered.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class of product. <i class="label label-info">read-only</i></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>subtotal</code></td>
|
|
<td>string</td>
|
|
<td>Line subtotal (before discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subtotal_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line subtotal tax (before discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Line total (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Line total tax (after discounts).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxes</code></td>
|
|
<td>array</td>
|
|
<td>Line total tax with <code>id</code>, <code>total</code> and <code>subtotal</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta</code></td>
|
|
<td>array</td>
|
|
<td>Line item meta data with <code>key</code>, <code>label</code> and <code>value</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-refund'>Create a refund</h2>
|
|
<p>This API helps you to create a new refund for an 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>/wp-json/wc/v1/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/wp-json/wc/v1/orders/116/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">'{
|
|
"amount": "10"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">amount</span><span class="p">:</span> <span class="dl">"</span><span class="s2">10</span><span class="dl">"</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="s2">orders/116/refunds</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'amount'</span> <span class="o">=></span> <span class="s1">'10'</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="nf">post</span><span class="p">(</span><span class="s1">'orders/116/refunds'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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="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/116/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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">amount: </span><span class="s2">"10"</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/116/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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">150</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T17:28:05"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds/150"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116"</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='retrieve-a-refund'>Retrieve a refund</h2>
|
|
<p>This API lets you retrieve and view a specific refund from an 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>/wp-json/wc/v1/orders/<id>/refunds/<refund_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/orders/116/refunds/150 <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="s2">orders/116/refunds/150</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'orders/116/refunds/150'</span><span class="p">));</span> <span class="cp">?></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/116/refunds/150"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/116/refunds/150"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">150</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T17:28:05"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds/150"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>dp</code></td>
|
|
<td>string</td>
|
|
<td>Number of decimal points to use in each resource.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='list-all-refunds'>List all refunds</h2>
|
|
<p>This API helps you to view all the refunds from an order.</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>/wp-json/wc/v1/orders/<id>/refunds</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/orders/116/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="s2">orders/116/refunds</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'orders/116/refunds'</span><span class="p">));</span> <span class="cp">?></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/116/refunds"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/116/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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">151</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T17:31:48"</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">"2.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="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">"Woo Single #2"</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">"12345"</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">99</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"variation_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">"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">""</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">"-2.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">"-2.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">"-2.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">"taxes"</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="p">}</span><span class="w">
|
|
</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds/151"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">150</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T17:28:05"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds/150"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116"</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-parameters-2'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>after</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published after a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>before</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published before a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dates_are_gmt</code></td>
|
|
<td>boolean</td>
|
|
<td>Interpret <code>after</code> and <code>before</code> as UTC dates when <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>date</code>, Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dp</code></td>
|
|
<td>string</td>
|
|
<td>Number of decimal points to use in each resource.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='delete-a-refund'>Delete a refund</h2>
|
|
<p>This API helps you delete an order refund.</p>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/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/wp-json/wc/v1/orders/116/refunds/150?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="s2">orders/116/refunds/150</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'orders/116/refunds/150'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/116/refunds/150"</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 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/116/refunds/150"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">150</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-30T17:28:05"</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="nl">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds/150"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116/refunds"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/orders/116"</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-parameters-3'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h1 id='products'>Products</h1>
|
|
<p>The products API allows you to create, view, update, and delete individual, or a batch, of products.</p>
|
|
<h2 id='product-properties'>Product 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Product name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Product slug.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>permalink</code></td>
|
|
<td>string</td>
|
|
<td>Product URL. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the product was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the product was last modified, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Product type. Default is <code>simple</code>. Options (plugins may add new options): <code>simple</code>, <code>grouped</code>, <code>external</code>, <code>variable</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Product status (post status). Default is <code>publish</code>. Options (plugins may add new options): <code>draft</code>, <code>pending</code>, <code>private</code> and <code>publish</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>featured</code></td>
|
|
<td>boolean</td>
|
|
<td>Featured product. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>catalog_visibility</code></td>
|
|
<td>string</td>
|
|
<td>Catalog visibility. Default is <code>visible</code>. Options: <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).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Product description.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>short_description</code></td>
|
|
<td>string</td>
|
|
<td>Product short description.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Unique identifier.</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>date_on_sale_from</code></td>
|
|
<td>string</td>
|
|
<td>Start date of sale price. Date in the <code>YYYY-MM-DD</code> format.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_to</code></td>
|
|
<td>string</td>
|
|
<td>Sets the sale end date. Date in the <code>YYYY-MM-DD</code> format.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price_html</code></td>
|
|
<td>string</td>
|
|
<td>Price formatted in HTML, e.g. <code><del><span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">&#36;&nbsp;3.00</span></span></del> <ins><span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">&#36;&nbsp;2.00</span></span></ins></code> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>on_sale</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the product is on sale. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>purchasable</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>total_sales</code></td>
|
|
<td>integer</td>
|
|
<td>Amount of sales. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>virtual</code></td>
|
|
<td>boolean</td>
|
|
<td>If the product is virtual. Virtual products are intangible and aren't shipped. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloadable</code></td>
|
|
<td>boolean</td>
|
|
<td>If the product is downloadable. Downloadable products give access to a file upon purchase. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads</code></td>
|
|
<td>array</td>
|
|
<td>List of downloadable files. See <a href="#download-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, the <code>-1</code> values means <strong>unlimited re-downloads</strong>. Default is <code>-1</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, the <code>-1</code> means that <strong>downloads never expires</strong>. Default is <code>-1</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> on the front-end. Default is <code>standard</code>. Options: <code>'standard'</code> (Standard Product), <code>application</code> (Application/Software) and <code>music</code> (Music).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>external_url</code></td>
|
|
<td>string</td>
|
|
<td>Product external URL. Only for <code>external</code> products.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>button_text</code></td>
|
|
<td>string</td>
|
|
<td>Product external button text. Only for <code>external</code> products.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status. Default is <code>taxable</code>. Options: <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>manage_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Stock management at product level. Default is <code>false</code>.</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. Default is <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backorders</code></td>
|
|
<td>string</td>
|
|
<td>If managing stock, this controls if backorders are allowed. If enabled, stock quantity can go below <code>0</code>. Default is <code>no</code>. Options are: <code>no</code> (Do not allow), <code>notify</code> (Allow, but notify customer), and <code>yes</code> (Allow).</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 <code>stock_quantity</code> negative). <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sold_individually</code></td>
|
|
<td>boolean</td>
|
|
<td>Allow one item to be bought in a single order. Default is <code>false</code>.</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>object</td>
|
|
<td>Product dimensions. See <a href="#dimension-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. <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>reviews_allowed</code></td>
|
|
<td>boolean</td>
|
|
<td>Allow reviews. Default is <code>true</code>.</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 (<code>post_parent</code>).</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>categories</code></td>
|
|
<td>array</td>
|
|
<td>List of categories. See <a href="#category-properties">Categories properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tags</code></td>
|
|
<td>array</td>
|
|
<td>List of tags. See <a href="#tag-properties">Tags properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>images</code></td>
|
|
<td>array</td>
|
|
<td>List of images. See <a href="#image-properties">Images properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attributes</code></td>
|
|
<td>array</td>
|
|
<td>List of attributes. See <a href="#attribute-properties">Attributes properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default_attributes</code></td>
|
|
<td>array</td>
|
|
<td>Defaults variation attributes, used only for variations and pre-selected attributes on the frontend. See <a href="#default-attribute-properties">Default Attributes properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variations</code></td>
|
|
<td>array</td>
|
|
<td>List of variations. See <a href="#variation-properties">Variations properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>grouped_products</code></td>
|
|
<td>array</td>
|
|
<td>List of grouped products ID, only for <code>group</code> type products. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>menu_order</code></td>
|
|
<td>integer</td>
|
|
<td>Menu order, used to custom sort products.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='download-properties'>Download 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.</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='dimension-properties'>Dimension 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>
|
|
</tbody></table>
|
|
<h3 id='category-properties'>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.</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>
|
|
</tbody></table>
|
|
<h3 id='tag-properties'>Tag 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>Tag ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Tag name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Tag slug. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='image-properties'>Image 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). In write-mode used to attach pre-existing images.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was last modified, in the site's timezone. <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 used to upload new images.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Image name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>alt</code></td>
|
|
<td>string</td>
|
|
<td>Image alternative text.</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='attribute-properties'>Attribute 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>Attribute ID (required if is a global attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name (required if is a non-global attribute).</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>Define if the attribute is visible on the "Additional Information" tab in the product's page. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variation</code></td>
|
|
<td>boolean</td>
|
|
<td>Define if the attribute can be used as variation. Default is <code>false</code>.</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-attribute-properties'>Default attribute 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>Attribute ID (required if is a global attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name (required if is a non-global attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>option</code></td>
|
|
<td>string</td>
|
|
<td>Selected attribute term name.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='variation-properties'>Variation 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. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the variation was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the variation was last modified, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>permalink</code></td>
|
|
<td>string</td>
|
|
<td>Variation URL. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Unique identifier.</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>date_on_sale_from</code></td>
|
|
<td>string</td>
|
|
<td>Start date of sale price. Date in the <code>YYYY-MM-DD</code> format.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_to</code></td>
|
|
<td>string</td>
|
|
<td>Start date of sale price. Date in the <code>YYYY-MM-DD</code> format.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>on_sale</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the variation is on sale. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>purchasable</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>If the variation is visible.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>virtual</code></td>
|
|
<td>boolean</td>
|
|
<td>If the variation is virtual. Virtual variations are intangible and aren't shipped. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloadable</code></td>
|
|
<td>boolean</td>
|
|
<td>If the variation is downloadable. Downloadable variations give access to a file upon purchase. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads</code></td>
|
|
<td>array</td>
|
|
<td>List of downloadable files. See <a href="#download-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, the <code>-1</code> values means <strong>unlimited re-downloads</strong>. Default is <code>-1</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 variation, the <code>-1</code> means that <strong>downloads never expires</strong>. Default is <code>-1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status. Default is <code>taxable</code>. Options: <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>manage_stock</code></td>
|
|
<td>boolean, string</td>
|
|
<td>Stock management at variation level. Possible values are either a boolean or <code>parent</code>. Default is <code>false</code>.</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. Default is <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backorders</code></td>
|
|
<td>string</td>
|
|
<td>If managing stock, this controls if backorders are allowed. If enabled, stock quantity can go below <code>0</code>. Default is <code>no</code>. Options are: <code>no</code> (Do not allow), <code>notify</code> (Allow, but notify customer), and <code>yes</code> (Allow).</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 variation is on backorder (if the variation have the <code>stock_quantity</code> negative). <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>object</td>
|
|
<td>Variation dimensions. See <a href="#dimension-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. Only position <code>0</code> will be used. See <a href="#image-properties">Images properties</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attributes</code></td>
|
|
<td>array</td>
|
|
<td>List of variation attributes. See <a href="#variation-attribute-properties">Variation Attributes properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='variation-attribute-properties'>Variation attribute 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>Attribute ID (required if is a global attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name (required if is a non-global attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>option</code></td>
|
|
<td>string</td>
|
|
<td>Selected attribute term name.</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>/wp-json/wc/v1/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/wp-json/wc/v1/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">'{
|
|
"name": "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": [
|
|
{
|
|
"id": 9
|
|
},
|
|
{
|
|
"id": 14
|
|
}
|
|
],
|
|
"images": [
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg",
|
|
"position": 0
|
|
},
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg",
|
|
"position": 1
|
|
}
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="s2">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="s2">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="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="dl">"</span><span class="p">,</span>
|
|
<span class="na">short_description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">}</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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">"</span><span class="s2">products</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">9</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">14</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'images'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="nf">post</span><span class="p">(</span><span class="s1">'products'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</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="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </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="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">14</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">162</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"premium-quality-3"</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-3/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>21,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">163</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front.jpg"</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">""</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">164</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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>
|
|
<blockquote>
|
|
<p>Example of how to create a <code>variable</code> product with global and non-global attributes:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/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">'{
|
|
"name": "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": [
|
|
{
|
|
"id": 9
|
|
},
|
|
{
|
|
"id": 14
|
|
}
|
|
],
|
|
"images": [
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg",
|
|
"position": 0
|
|
},
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_back.jpg",
|
|
"position": 1
|
|
},
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg",
|
|
"position": 2
|
|
},
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_back.jpg",
|
|
"position": 3
|
|
}
|
|
],
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"position": 0,
|
|
"visible": false,
|
|
"variation": true,
|
|
"options": [
|
|
"Black",
|
|
"Green"
|
|
]
|
|
},
|
|
{
|
|
"name": "Size",
|
|
"position": 0,
|
|
"visible": true,
|
|
"variation": true,
|
|
"options": [
|
|
"S",
|
|
"M"
|
|
]
|
|
}
|
|
],
|
|
"default_attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "Black"
|
|
},
|
|
{
|
|
"name": "Size",
|
|
"option": "S"
|
|
}
|
|
],
|
|
"variations": [
|
|
{
|
|
"regular_price": "19.99",
|
|
"image": [
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg",
|
|
"position": 0
|
|
}
|
|
],
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "black"
|
|
},
|
|
{
|
|
"name": "Size",
|
|
"option": "S"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"regular_price": "19.99",
|
|
"image": [
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg",
|
|
"position": 0
|
|
}
|
|
],
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "green"
|
|
},
|
|
{
|
|
"name": "Size",
|
|
"option": "M"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="s2">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="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="dl">"</span><span class="p">,</span>
|
|
<span class="na">short_description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">}</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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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">id</span><span class="p">:</span> <span class="mi">6</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="na">visible</span><span class="p">:</span> <span class="kc">true</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="s2">Black</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="dl">"</span><span class="s2">Green</span><span class="dl">"</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="s2">Size</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="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="s2">S</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="dl">"</span><span class="s2">M</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">id</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Black</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Size</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">"</span><span class="s2">S</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="s2">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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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">id</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">"</span><span class="s2">black</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Size</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">"</span><span class="s2">S</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="s2">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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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">id</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">"</span><span class="s2">green</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Size</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">option</span><span class="p">:</span> <span class="dl">"</span><span class="s2">M</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="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">"</span><span class="s2">products</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">9</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">14</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'images'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">6</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="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="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">'name'</span> <span class="o">=></span> <span class="s1">'Size'</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="s1">'visible'</span> <span class="o">=></span> <span class="kc">true</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="p">[</span>
|
|
<span class="s1">'S'</span><span class="p">,</span>
|
|
<span class="s1">'M'</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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">6</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">'name'</span> <span class="o">=></span> <span class="s1">'Size'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'S'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'variations'</span> <span class="o">=></span> <span class="p">[</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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">6</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">'name'</span> <span class="o">=></span> <span class="s1">'Size'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'S'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">6</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="s1">'name'</span> <span class="o">=></span> <span class="s1">'Size'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'M'</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="nf">post</span><span class="p">(</span><span class="s1">'products'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</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="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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">"id"</span><span class="p">:</span> <span class="mi">6</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="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">"name"</span><span class="p">:</span> <span class="s">"Size"</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="s">"visible"</span><span class="p">:</span> <span class="bp">True</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">"S"</span><span class="p">,</span>
|
|
<span class="s">"M"</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">"id"</span><span class="p">:</span> <span class="mi">6</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">"name"</span><span class="p">:</span> <span class="s">"Size"</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"S"</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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">"id"</span><span class="p">:</span> <span class="mi">6</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">"name"</span><span class="p">:</span> <span class="s">"Size"</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"S"</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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">"id"</span><span class="p">:</span> <span class="mi">6</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="s">"name"</span><span class="p">:</span> <span class="s">"Size"</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"M"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </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="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">14</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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">id: </span><span class="mi">6</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">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">name: </span><span class="s2">"Size"</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="mi">0</span><span class="p">,</span>
|
|
<span class="ss">visible: </span><span class="kp">true</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">"S"</span><span class="p">,</span>
|
|
<span class="s2">"M"</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">id: </span><span class="mi">6</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">name: </span><span class="s2">"Size"</span><span class="p">,</span>
|
|
<span class="ss">option: </span><span class="s2">"S"</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_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">id: </span><span class="mi">6</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">name: </span><span class="s2">"Size"</span><span class="p">,</span>
|
|
<span class="ss">option: </span><span class="s2">"S"</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_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">id: </span><span class="mi">6</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="ss">name: </span><span class="s2">"Size"</span><span class="p">,</span>
|
|
<span class="ss">option: </span><span class="s2">"M"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">165</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ship-your-idea-4"</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/ship-your-idea-4/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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">"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">"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">"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">"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">""</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>19,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">34</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">187</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">205</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">166</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</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">"https://example.com/wp-content/uploads/2016/05/T_4_front.jpg"</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">""</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">167</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</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">"https://example.com/wp-content/uploads/2016/05/T_4_back.jpg"</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">""</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">168</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:58"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:58"</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">"https://example.com/wp-content/uploads/2016/05/T_3_front.jpg"</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">""</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">169</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:59"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:59"</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">"https://example.com/wp-content/uploads/2016/05/T_3_back.jpg"</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">""</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">"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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Size"</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="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">"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">"S"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"M"</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">"default_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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"S"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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">170</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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/ship-your-idea-4/?attribute_pa_color=black&attribute_size=S"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"purchasable"</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">"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">"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">"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">-1</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">-1</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">171</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:01"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:01"</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">"https://example.com/wp-content/uploads/2016/05/T_4_front-1.jpg"</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">""</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"S"</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">172</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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/ship-your-idea-4/?attribute_pa_color=green&attribute_size=M"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"purchasable"</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">"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">"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">"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">-1</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">-1</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example.com/wp-content/uploads/2016/05/T_3_front-1.jpg"</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">""</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"M"</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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/165"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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='retrieve-a-product'>Retrieve a product</h2>
|
|
<p>This API lets you retrieve and view a specific product by ID.</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>/wp-json/wc/v1/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/162 <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="s2">products/162</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/162'</span><span class="p">));</span> <span class="cp">?></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/162"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/162"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">162</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"premium-quality-3"</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-3/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>21,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">163</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front.jpg"</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">""</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">164</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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='list-all-products'>List all 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>/wp-json/wc/v1/products</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">products</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">165</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ship-your-idea-4"</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/ship-your-idea-4/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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">"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">"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">"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">"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">""</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>19,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">34</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">187</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">205</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">166</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</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">"https://example.com/wp-content/uploads/2016/05/T_4_front.jpg"</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">""</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">167</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</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">"https://example.com/wp-content/uploads/2016/05/T_4_back.jpg"</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">""</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">168</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:58"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:58"</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">"https://example.com/wp-content/uploads/2016/05/T_3_front.jpg"</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">""</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">169</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:59"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:59"</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">"https://example.com/wp-content/uploads/2016/05/T_3_back.jpg"</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">""</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">"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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Size"</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="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">"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">"S"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"M"</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">"default_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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"S"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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">170</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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/ship-your-idea-4/?attribute_pa_color=black&attribute_size=S"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"purchasable"</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">"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">"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">"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">-1</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">-1</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">171</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:01"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:01"</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">"https://example.com/wp-content/uploads/2016/05/T_4_front-1.jpg"</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">""</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"S"</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">172</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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/ship-your-idea-4/?attribute_pa_color=green&attribute_size=M"</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"purchasable"</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">"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">"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">"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">-1</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">-1</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example.com/wp-content/uploads/2016/05/T_3_front-1.jpg"</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">""</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"M"</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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/165"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">162</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"premium-quality-3"</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-3/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>21,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">163</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front.jpg"</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">""</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">164</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>after</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published after a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>before</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published before a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dates_are_gmt</code></td>
|
|
<td>boolean</td>
|
|
<td>Interpret <code>after</code> and <code>before</code> as UTC dates when <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>date</code>, Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific slug.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific status. Default is <code>any</code>. Options: <code>any</code>, <code>draft</code>, <code>pending</code>, <code>private</code> and <code>publish</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to orders assigned a specific customer.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>category</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific category, e.g. <code>?category=9,14</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tag</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific tag, e.g. <code>?tag=9,14</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific shipping class, e.g. <code>?shipping_class=9,14</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribute</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific attribute, e.g. <code>?attribute=pa_color</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribute_term</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific attribute term (required an assigned <code>attribute</code>), e.g. <code>?attribute=pa_color&attribute_term=9,14</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific 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>/wp-json/wc/v1/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/wp-json/wc/v1/products/162 <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">'{
|
|
"regular_price": "24.54"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">"</span><span class="s2">24.54</span><span class="dl">"</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="s2">products/162</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'24.54'</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="nf">put</span><span class="p">(</span><span class="s1">'products/162'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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="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/162"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"24.54"</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/162"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">162</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"premium-quality-3"</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-3/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>24,54</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">163</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front.jpg"</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">""</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">164</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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-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>/wp-json/wc/v1/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/wp-json/wc/v1/products/162?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="s2">products/162</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'products/162'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/162"</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 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/162"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">162</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"premium-quality-3"</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-3/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>24,54</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">163</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front.jpg"</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">""</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">164</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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-parameters-2'>Available parameters</h4>
|
|
<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, Default is <code>false</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-products'>Batch update products</h2>
|
|
<p>This API helps you to batch create, update and delete multiple products.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-6'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/products/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "Woo Single #1",
|
|
"type": "simple",
|
|
"regular_price": "21.99",
|
|
"virtual": true,
|
|
"downloadable": true,
|
|
"downloads": [
|
|
{
|
|
"name": "Woo Single",
|
|
"file": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"id": 11
|
|
},
|
|
{
|
|
"id": 13
|
|
}
|
|
],
|
|
"images": [
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg",
|
|
"position": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "New 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": [
|
|
{
|
|
"id": 9
|
|
},
|
|
{
|
|
"id": 14
|
|
}
|
|
],
|
|
"images": [
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg",
|
|
"position": 0
|
|
},
|
|
{
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg",
|
|
"position": 1
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 165,
|
|
"variations": [
|
|
{
|
|
"id": 170,
|
|
"regular_price": "29.99"
|
|
},
|
|
{
|
|
"id": 172,
|
|
"regular_price": "29.99"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"delete": [
|
|
162
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">Woo Single #1</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="s2">21.99</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">virtual</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">downloadable</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">downloads</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="s2">Woo Single</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">file</span><span class="p">:</span> <span class="dl">"</span><span class="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">categories</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">11</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">13</span>
|
|
<span class="p">}</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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.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="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">New 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="s2">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="s2">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="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="dl">"</span><span class="p">,</span>
|
|
<span class="na">short_description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">}</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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">165</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">id</span><span class="p">:</span> <span class="mi">170</span><span class="p">,</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">"</span><span class="s2">29.99</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">172</span><span class="p">,</span>
|
|
<span class="na">regular_price</span><span class="p">:</span> <span class="dl">"</span><span class="s2">29.99</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">162</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="s2">products/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Woo Single #1'</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">'virtual'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'downloadable'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'downloads'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Woo Single'</span><span class="p">,</span>
|
|
<span class="s1">'file'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'categories'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">11</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">13</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'images'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.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="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'New 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="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">9</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">14</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'images'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">165</span><span class="p">,</span>
|
|
<span class="s1">'variations'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">170</span><span class="p">,</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'29.99'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">172</span><span class="p">,</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'29.99'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">162</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="nf">post</span><span class="p">(</span><span class="s1">'products/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"Woo Single #1"</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">"virtual"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"downloadable"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"downloads"</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">"Woo Single"</span><span class="p">,</span>
|
|
<span class="s">"file"</span><span class="p">:</span> <span class="s">"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">11</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">13</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.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="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"New 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="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">165</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">"id"</span><span class="p">:</span> <span class="mi">170</span><span class="p">,</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"29.99"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">172</span><span class="p">,</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"29.99"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">162</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/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Woo Single #1"</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">virtual: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">downloadable: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">downloads: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Woo Single"</span><span class="p">,</span>
|
|
<span class="ss">file: </span><span class="s2">"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">categories: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">11</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">13</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.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="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"New 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="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">14</span>
|
|
<span class="p">}</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_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="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">165</span><span class="p">,</span>
|
|
<span class="ss">variations: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">170</span><span class="p">,</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"29.99"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">172</span><span class="p">,</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"29.99"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">162</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/batch"</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">"create"</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">174</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 Single #1"</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">"woo-single-1-2"</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/woo-single-1-2/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:30"</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">"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">"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">"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">"short_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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>21,99</span>"</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">"purchasable"</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">"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">"virtual"</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">"downloadable"</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">"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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7b5a304f737cfa35dc527c9e790399bf"</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 Single"</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://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"</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_limit"</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">"download_expiry"</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">"download_type"</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">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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">false</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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">175</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:31"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:31"</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">"https://example.com/wp-content/uploads/2016/05/cd_4_angle.jpg"</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">""</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="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/174"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">176</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">"New Premium Quality"</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">"new-premium-quality"</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/new-premium-quality/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:33"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:33"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>21,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">177</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:33"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:33"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front-1.jpg"</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">""</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">178</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:34"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:21:34"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back-1.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/176"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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="nl">"update"</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">165</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ship-your-idea-4"</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/ship-your-idea-4/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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">"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">"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">"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">"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">"29.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">""</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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>29,99</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">34</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">187</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">205</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">166</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</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">"https://example.com/wp-content/uploads/2016/05/T_4_front.jpg"</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">""</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">167</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:57"</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">"https://example.com/wp-content/uploads/2016/05/T_4_back.jpg"</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">""</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">168</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:58"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:58"</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">"https://example.com/wp-content/uploads/2016/05/T_3_front.jpg"</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">""</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">169</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:59"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:59"</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">"https://example.com/wp-content/uploads/2016/05/T_3_back.jpg"</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">""</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">"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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Size"</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="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">"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">"S"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"M"</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">"default_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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"S"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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">170</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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/ship-your-idea-4/?attribute_pa_color=black&attribute_size=S"</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">"29.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">"29.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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"purchasable"</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">"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">"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">"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">-1</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">-1</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">171</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:01"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:01"</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">"https://example.com/wp-content/uploads/2016/05/T_4_front-1.jpg"</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">""</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"S"</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">172</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:50:56"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-02T23:11:41"</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/ship-your-idea-4/?attribute_pa_color=green&attribute_size=M"</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">"29.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">"29.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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"purchasable"</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">"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">"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">"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">-1</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">-1</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example.com/wp-content/uploads/2016/05/T_3_front-1.jpg"</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">""</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"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">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"size"</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">"M"</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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/165"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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="nl">"delete"</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">162</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"premium-quality-3"</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-3/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-06-01T00:13:45"</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">"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">"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">"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">"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="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to"</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_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-amount amount</span><span class="se">\"</span><span class="s2">><span class=</span><span class="se">\"</span><span class="s2">woocommerce-Price-currencySymbol</span><span class="se">\"</span><span class="s2">>&#82;&#36;</span>24,54</span>"</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">"purchasable"</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">"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">"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">"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">"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">-1</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">-1</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">"standard"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"external_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"button_text"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">"manage_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="kc">null</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"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no"</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">"weight"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="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="mi">0</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="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">"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">"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">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="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="w">
|
|
</span><span class="p">}</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">163</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:07"</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">"https://example.com/wp-content/uploads/2016/05/T_2_front.jpg"</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">""</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">164</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:40:10"</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">"https://example.com/wp-content/uploads/2016/05/T_2_back.jpg"</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">""</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">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"default_attributes"</span><span class="p">:</span><span class="w"> </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">"grouped_products"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products"</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><h2 id='retrieve-product-reviews'>Retrieve product reviews</h2>
|
|
<p>This API lets you retrieve and view a specific product review by ID.</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>/wp-json/wc/v1/products/<product_id>/reviews/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/162/reviews/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="s2">products/162/reviews/9</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/162'</span><span class="p">));</span> <span class="cp">?></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/162/reviews/9"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/162/reviews/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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-05-07T13:01:25"</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 will go great with my Hoodie that I ordered a few weeks ago."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">"Stuart"</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">"stuart@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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162/reviews/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162/reviews"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</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='product-review-properties'>Product review 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>string</td>
|
|
<td>The date the review was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rating</code></td>
|
|
<td>integer</td>
|
|
<td>Review rating (0 to 5). <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Reviewer name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>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='list-all-product-reviews'>List all product reviews</h2>
|
|
<p>This API lets you retrieve all reviews of a product.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/<product_id>/reviews</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/162/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="s2">products/162/reviews</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/162/reviews'</span><span class="p">));</span> <span class="cp">?></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/162/reviews"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/162/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="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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-05-07T13:01:25"</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 will go great with my Hoodie that I ordered a few weeks ago."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">"Stuart"</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">"stuart@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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162/reviews/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162/reviews"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</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="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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-05-07T15:49:53"</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">"Love this shirt! The ninja near and dear to my heart. &lt;3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">"Maria"</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">"maria@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="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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162/reviews/10"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162/reviews"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/162"</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><h1 id='product-attributes'>Product attributes</h1>
|
|
<p>The product attributes API allows you to create, view, update, and delete individual, or a batch, of product attributes.</p>
|
|
<h2 id='product-attribute-properties'>Product attribute 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<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>An alphanumeric identifier for the resource unique to its type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Type of attribute. Default is <code>select</code>. Options: <code>select</code> and <code>text</code> (some plugins can include new types)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_by</code></td>
|
|
<td>string</td>
|
|
<td>Default sort order. Default is <code>menu_order</code>. Options: <code>menu_order</code>, <code>name</code>, <code>name_num</code> and <code>id</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>has_archives</code></td>
|
|
<td>boolean</td>
|
|
<td>Enable/Disable attribute archives. Default is <code>false</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-product-attribute'>Create a product attribute</h2>
|
|
<p>This API helps you to create a new product attribute.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/attributes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/products/attributes <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">'{
|
|
"name": "Color",
|
|
"slug": "pa_color",
|
|
"type": "select",
|
|
"order_by": "menu_order",
|
|
"has_archives": true
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">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="s2">pa_color</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">"</span><span class="s2">select</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">order_by</span><span class="p">:</span> <span class="dl">"</span><span class="s2">menu_order</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">has_archives</span><span class="p">:</span> <span class="kc">true</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="s2">products/attributes</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="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">'pa_color'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'select'</span><span class="p">,</span>
|
|
<span class="s1">'order_by'</span> <span class="o">=></span> <span class="s1">'menu_order'</span><span class="p">,</span>
|
|
<span class="s1">'has_archives'</span> <span class="o">=></span> <span class="kc">true</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="nf">post</span><span class="p">(</span><span class="s1">'products/attributes'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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">"pa_color"</span><span class="p">,</span>
|
|
<span class="s">"type"</span><span class="p">:</span> <span class="s">"select"</span><span class="p">,</span>
|
|
<span class="s">"order_by"</span><span class="p">:</span> <span class="s">"menu_order"</span><span class="p">,</span>
|
|
<span class="s">"has_archives"</span><span class="p">:</span> <span class="bp">True</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/attributes"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</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">"pa_color"</span><span class="p">,</span>
|
|
<span class="ss">type: </span><span class="s2">"select"</span><span class="p">,</span>
|
|
<span class="ss">order_by: </span><span class="s2">"menu_order"</span><span class="p">,</span>
|
|
<span class="ss">has_archives: </span><span class="kp">true</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/attributes"</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">"id"</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">"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">"pa_color"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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='retrieve-a-product-attribute'>Retrieve a product attribute</h2>
|
|
<p>This API lets you retrieve and view a specific product attribute by ID.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/attributes/1 <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="s2">products/attributes/1</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/attributes/1'</span><span class="p">));</span> <span class="cp">?></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/attributes/1"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/attributes/1"</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">"id"</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">"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">"pa_color"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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='list-all-product-attributes'>List all product attributes</h2>
|
|
<p>This API helps you to view all the product attributes.</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>/wp-json/wc/v1/products/attributes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/attributes <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="s2">products/attributes</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/attributes'</span><span class="p">));</span> <span class="cp">?></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/attributes"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/attributes"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"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">"pa_color"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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="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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Size"</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">"pa_size"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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><h2 id='update-a-product-attribute'>Update a product attribute</h2>
|
|
<p>This API lets you make changes to a product attribute.</p>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v1/products/attributes/1 <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_by": "name"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">order_by</span><span class="p">:</span> <span class="dl">"</span><span class="s2">name</span><span class="dl">"</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="s2">products/attributes/1</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'order_by'</span> <span class="o">=></span> <span class="s1">'name'</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="nf">put</span><span class="p">(</span><span class="s1">'products/attributes/1'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"order_by"</span><span class="p">:</span> <span class="s">"name"</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/attributes/1"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">order_by: </span><span class="s2">"name"</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/attributes/1"</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">"id"</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">"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">"pa_color"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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-a-product-attribute'>Delete a product attribute</h2>
|
|
<p>This API helps you delete a product attribute.</p>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
<aside class="warning">
|
|
This also will delete all terms from the selected attribute.
|
|
</aside>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/products/attributes/1?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="s2">products/attributes/1</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'products/attributes/1'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/attributes/1"</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 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/attributes/1"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</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">"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">"pa_color"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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-parameters'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-product-attributes'>Batch update product attributes</h2>
|
|
<p>This API helps you to batch create, update and delete multiple product attributes.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-5'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/products/attributes/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "Brand"
|
|
},
|
|
{
|
|
"name": "Publisher"
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 2,
|
|
"order_by": "name"
|
|
}
|
|
],
|
|
"delete": [
|
|
1
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">Brand</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Publisher</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
|
<span class="na">order_by</span><span class="p">:</span> <span class="dl">"</span><span class="s2">name</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">1</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="s2">products/attributes/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Brand'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Publisher'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">2</span><span class="p">,</span>
|
|
<span class="s1">'order_by'</span> <span class="o">=></span> <span class="s1">'name'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">1</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="nf">post</span><span class="p">(</span><span class="s1">'products/attributes/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"Brand"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Publisher"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
|
<span class="s">"order_by"</span><span class="p">:</span> <span class="s">"name"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">1</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/attributes/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Round toe"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Flat"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">2</span><span class="p">,</span>
|
|
<span class="ss">order_by: </span><span class="s2">"name"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">1</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/attributes/batch"</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">"create"</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">7</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">"Brand"</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">"pa_brand"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/7"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</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">"Publisher"</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">"pa_publisher"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/8"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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="nl">"update"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Size"</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">"pa_size"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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="nl">"delete"</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">1</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">"pa_color"</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">"select"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order_by"</span><span class="p">:</span><span class="w"> </span><span class="s2">"menu_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_archives"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes"</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><h1 id='product-attribute-terms'>Product attribute terms</h1>
|
|
<p>The product attribute terms API allows you to create, view, update, and delete individual, or a batch, of attribute terms.</p>
|
|
<h2 id='attribute-term-properties'>Attribute term 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Term name. <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>An alphanumeric identifier for the resource unique to its type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>HTML description of the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>menu_order</code></td>
|
|
<td>integer</td>
|
|
<td>Menu order, used to custom sort the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>count</code></td>
|
|
<td>integer</td>
|
|
<td>Number of published products for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-an-attribute-term'>Create an attribute term</h2>
|
|
<p>This API helps you to create a new product attribute term.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<attribute_id>/terms</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/products/attributes/2/terms <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">'{
|
|
"name": "XXS"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">XXS</span><span class="dl">"</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="s2">products/attributes/2/terms</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'XXS'</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="nf">post</span><span class="p">(</span><span class="s1">'products/attributes/2/terms'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"XXS"</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/attributes/2/terms"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"XXS"</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/attributes/2/terms"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">"XXS"</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">"xxs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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='retrieve-an-attribute-term'>Retrieve an attribute term</h2>
|
|
<p>This API lets you retrieve a product attribute term by ID.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<attribute_id>/terms/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/attributes/2/terms/23 <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="s2">products/attributes/2/terms/23</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/attributes/2/terms/23'</span><span class="p">));</span> <span class="cp">?></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/attributes/2/terms/23"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/attributes/2/terms/23"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">"XXS"</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">"xxs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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='list-all-attribute-terms'>List all attribute terms</h2>
|
|
<p>This API lets you retrieve all terms from a product attribute.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<attribute_id>/terms</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/attributes/2/terms <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="s2">products/attributes/2/terms</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/attributes/2/terms'</span><span class="p">));</span> <span class="cp">?></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/attributes/2/terms"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/attributes/2/terms"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">"XXS"</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">"xxs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</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">"XS"</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">"xs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">17</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">"S"</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">"s"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/17"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</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">"M"</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">"m"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/18"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"L"</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">"l"</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">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">1</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/19"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</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">"XL"</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">"xl"</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">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">1</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/20"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">21</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">"XXL"</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">"xxl"</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">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</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">1</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/21"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>name</code>. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>bool</td>
|
|
<td>Whether to hide resources not assigned to any products. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to resources assigned to a specific parent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to resources assigned to a specific product.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific slug.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-an-attribute-term'>Update an attribute term</h2>
|
|
<p>This API lets you make changes to a product attribute term.</p>
|
|
<h3 id='http-request-2'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<attribute_id>/terms/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v1/products/attributes/2/terms/23 <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">'{
|
|
"name": "XXS"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">XXS</span><span class="dl">"</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="s2">products/attributes/2/terms/23</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'XXS'</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="nf">put</span><span class="p">(</span><span class="s1">'products/attributes/2/terms/23'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"XXS"</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/attributes/2/terms/23"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"XXS"</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/attributes/2/terms/23"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">"XXS"</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">"xxs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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-attribute-term'>Delete an attribute term</h2>
|
|
<p>This API helps you delete a product attribute term.</p>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<attribute_id>/terms/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/products/attributes/2/terms/23?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="s2">products/attributes/2/terms/23</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'products/attributes/2/terms/23'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/attributes/2/terms/23"</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 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/attributes/2/terms/23"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</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">"XXS"</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">"xxs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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-parameters-2'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-attribute-terms'>Batch update attribute terms</h2>
|
|
<p>This API helps you to batch create, update and delete multiple product attribute terms.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/attributes/<attribute_id>/terms/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/products/attributes/&lt<span class="p">;</span>attribute_id&gt<span class="p">;</span>/terms/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "XXS"
|
|
},
|
|
{
|
|
"name": "S"
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 19,
|
|
"menu_order": 6
|
|
}
|
|
],
|
|
"delete": [
|
|
21,
|
|
20
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">XXS</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">S</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">19</span><span class="p">,</span>
|
|
<span class="na">menu_order</span><span class="p">:</span> <span class="mi">6</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">21</span><span class="p">,</span>
|
|
<span class="mi">20</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="s2">products/attributes/2/terms/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'XXS'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'S'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">19</span><span class="p">,</span>
|
|
<span class="s1">'menu_order'</span> <span class="o">=></span> <span class="mi">6</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">21</span><span class="p">,</span>
|
|
<span class="mi">20</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="nf">post</span><span class="p">(</span><span class="s1">'products/attributes/2/terms/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"XXS"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"S"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">19</span><span class="p">,</span>
|
|
<span class="s">"menu_order"</span><span class="p">:</span> <span class="mi">6</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">21</span><span class="p">,</span>
|
|
<span class="mi">20</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/attributes/2/terms/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"XXS"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"S"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">19</span><span class="p">,</span>
|
|
<span class="ss">menu_order: </span><span class="mi">6</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">21</span><span class="p">,</span>
|
|
<span class="mi">20</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/attributes/2/terms/batch"</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">"create"</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">23</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">"XXS"</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">"xxs"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">17</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">"S"</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">"s"</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">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/17"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"update"</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">19</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">"L"</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">"l"</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">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">1</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/19"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"delete"</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">21</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">"XXL"</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">"xxl"</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">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</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">1</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/21"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</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">"XL"</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">"xl"</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">"menu_order"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">1</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms/20"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/attributes/2/terms"</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><h1 id='product-categories'>Product categories</h1>
|
|
<p>The product categories API allows you to create, view, update, and delete individual, or a batch, of categories.</p>
|
|
<h2 id='product-category-properties'>Product category 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>Unique identifier for the resource. <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">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>An alphanumeric identifier for the resource unique to its type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>integer</td>
|
|
<td>The id for the parent of the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>HTML description of the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>display</code></td>
|
|
<td>string</td>
|
|
<td>Category archive display type. Default is <code>default</code>. Options: <code>default</code>, <code>products</code>, <code>subcategories</code> and <code>both</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>image</code></td>
|
|
<td>array</td>
|
|
<td>Image data. See <a href="#category-image-properties">Category Image properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>menu_order</code></td>
|
|
<td>integer</td>
|
|
<td>Menu order, used to custom sort the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>count</code></td>
|
|
<td>integer</td>
|
|
<td>Number of published products for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='category-image-properties'>Category Image 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). In write-mode used to attach pre-existing images.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was last modified, in the site's timezone. <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 used to upload new images.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Image name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>alt</code></td>
|
|
<td>string</td>
|
|
<td>Image alternative text.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-product-category'>Create a product category</h2>
|
|
<p>This API helps you to create a new product category.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/categories</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of how to create a product category:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/products/categories <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">'{
|
|
"name": "Clothing",
|
|
"image": {
|
|
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
|
|
}
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Clothing</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">image</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">src</span><span class="p">:</span> <span class="dl">"</span><span class="s2">http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg</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="s2">products/categories</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Clothing'</span><span class="p">,</span>
|
|
<span class="s1">'image'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="s1">'src'</span> <span class="o">=></span> <span class="s1">'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg'</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="nf">post</span><span class="p">(</span><span class="s1">'products/categories'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Clothing"</span><span class="p">,</span>
|
|
<span class="s">"image"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"src"</span><span class="p">:</span> <span class="s">"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"</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/categories"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Clothing"</span><span class="p">,</span>
|
|
<span class="ss">image: </span><span class="p">{</span>
|
|
<span class="ss">src: </span><span class="s2">"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"</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/categories"</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">"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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example/wp-content/uploads/2016/05/T_3_front-1.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="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories"</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='retrieve-a-product-category'>Retrieve a product category</h2>
|
|
<p>This API lets you retrieve a product category by ID.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/categories/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">products/categories/9</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/categories/9'</span><span class="p">));</span> <span class="cp">?></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 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">"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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example/wp-content/uploads/2016/05/T_3_front-1.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="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories"</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='list-all-product-categories'>List all product categories</h2>
|
|
<p>This API lets you retrieve all product categories.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/categories</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">products/categories</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/categories'</span><span class="p">));</span> <span class="cp">?></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 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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/15"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/11"</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="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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example/wp-content/uploads/2016/05/T_3_front-1.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="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/10"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/9"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/11"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/12"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/13"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/11"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/9"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>name</code>. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>bool</td>
|
|
<td>Whether to hide resources not assigned to any products. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to resources assigned to a specific parent.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to resources assigned to a specific product.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific slug.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-product-category'>Update a product category</h2>
|
|
<p>This API lets you make changes to a product category.</p>
|
|
<h3 id='http-request-2'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v1/products/categories/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v1/products/categories/9 <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">'{
|
|
"description": "All kinds of clothes."
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">All kinds of clothes.</span><span class="dl">"</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="s2">products/categories/9</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'All kinds of clothes.'</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="nf">put</span><span class="p">(</span><span class="s1">'products/categories/9'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"All kinds of clothes."</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/categories/9"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">description: </span><span class="s2">"All kinds of clothes."</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/categories/9"</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">"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">"All kinds of clothes."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example/wp-content/uploads/2016/05/T_3_front-1.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="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories"</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-a-product-category'>Delete a product category</h2>
|
|
<p>This API helps you delete a product category.</p>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/products/categories/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/products/categories/9?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="s2">products/categories/9</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'products/categories/9'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/categories/9"</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 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/categories/9"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"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">"All kinds of clothes."</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">173</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-31T23:51:03"</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">"https://example/wp-content/uploads/2016/05/T_3_front-1.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="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example/wp-json/wc/v1/products/categories"</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-parameters-2'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-product-categories'>Batch update product categories</h2>
|
|
<p>This API helps you to batch create, update and delete multiple product categories.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/categories/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/products/categories/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "Albums"
|
|
},
|
|
{
|
|
"name": "Clothing"
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 10,
|
|
"description": "Nice hoodies"
|
|
}
|
|
],
|
|
"delete": [
|
|
11,
|
|
12
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">Albums</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Clothing</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Nice hoodies</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">11</span><span class="p">,</span>
|
|
<span class="mi">12</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="s2">products/categories/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Albums'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Clothing'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">10</span><span class="p">,</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'Nice hoodies'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">11</span><span class="p">,</span>
|
|
<span class="mi">12</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="nf">post</span><span class="p">(</span><span class="s1">'products/categories/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"Albums"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Clothing"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Nice hoodies"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">11</span><span class="p">,</span>
|
|
<span class="mi">12</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/categories/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Albums"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Clothing"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">10</span><span class="p">,</span>
|
|
<span class="ss">description: </span><span class="s2">"Nice hoodies"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">11</span><span class="p">,</span>
|
|
<span class="mi">12</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/categories/batch"</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">"create"</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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/15"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/11"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/9"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</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="nl">"update"</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">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">"Nice hoodies"</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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/10"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/9"</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="nl">"delete"</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">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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/11"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</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="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="p">[],</span><span class="w">
|
|
</span><span class="nl">"menu_order"</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">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories/12"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/categories"</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><h1 id='product-shipping-classes'>Product shipping classes</h1>
|
|
<p>The product shipping class API allows you to create, view, update, and delete individual, or a batch, of shipping classes.</p>
|
|
<h2 id='shipping-class-properties'>Shipping class 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Shipping class name. <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>An alphanumeric identifier for the resource unique to its type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>HTML description of the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>count</code></td>
|
|
<td>integer</td>
|
|
<td>Number of published products for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-shipping-class'>Create a shipping class</h2>
|
|
<p>This API helps you to create a new product shipping class.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/shipping_classes</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of how to create a product shipping class:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/products/shipping_classes <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">'{
|
|
"name": "Priority"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Priority</span><span class="dl">"</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="s2">products/shipping_classes</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Priority'</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="nf">post</span><span class="p">(</span><span class="s1">'products/shipping_classes'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Priority"</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/shipping_classes"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Priority"</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/shipping_classes"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</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">"Priority"</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">"priority"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/32"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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='retrieve-a-shipping-class'>Retrieve a shipping class</h2>
|
|
<p>This API lets you retrieve a product shipping class by ID.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/shipping_classes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/shipping_classes/32 <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="s2">products/shipping_classes/32</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/shipping_classes/32'</span><span class="p">));</span> <span class="cp">?></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/shipping_classes/32"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/shipping_classes/32"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</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">"Priority"</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">"priority"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/32"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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='list-all-shipping-classes'>List all shipping classes</h2>
|
|
<p>This API lets you retrieve all product shipping classes.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/shipping_classes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/shipping_classes <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="s2">products/shipping_classes</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/shipping_classes'</span><span class="p">));</span> <span class="cp">?></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/shipping_classes"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/shipping_classes"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">33</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">"Express"</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">"express"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/33"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</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">"Priority"</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">"priority"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/32"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>name</code>. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>bool</td>
|
|
<td>Whether to hide resources not assigned to any products. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to resources assigned to a specific product.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific slug.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-shipping-class'>Update a shipping class</h2>
|
|
<p>This API lets you make changes to a product shipping class.</p>
|
|
<h3 id='http-request-2'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v1/products/shipping_classes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v1/products/shipping_classes/32 <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">'{
|
|
"description": "Priority mail."
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Priority mail.</span><span class="dl">"</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="s2">products/shipping_classes/32</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'Priority mail.'</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="nf">put</span><span class="p">(</span><span class="s1">'products/shipping_classes/32'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Priority mail."</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/shipping_classes/32"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">description: </span><span class="s2">"Priority mail."</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/shipping_classes/32"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</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">"Priority"</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">"priority"</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">"Priority mail."</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">0</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/32"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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-a-shipping-class'>Delete a shipping class</h2>
|
|
<p>This API helps you delete a product shipping class.</p>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/products/shipping_classes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/products/shipping_classes/32?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="s2">products/shipping_classes/32</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'products/shipping_classes/32'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/shipping_classes/32"</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 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/shipping_classes/32"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</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">"Priority"</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">"priority"</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">"Priority mail."</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">0</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/32"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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-parameters-2'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-shipping-classes'>Batch update shipping classes</h2>
|
|
<p>This API helps you to batch create, update and delete multiple product shipping classes.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/shipping_classes/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/products/shipping_classes/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "Small items"
|
|
},
|
|
{
|
|
"name": "Large items"
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 33,
|
|
"description": "Express shipping"
|
|
}
|
|
],
|
|
"delete": [
|
|
32
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">Small items</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Large items</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">33</span><span class="p">,</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Express shipping</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">32</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="s2">products/shipping_classes/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Small items'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Large items'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">33</span><span class="p">,</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'Express shipping'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">32</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="nf">post</span><span class="p">(</span><span class="s1">'products/shipping_classes/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"Small items"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Large items"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">33</span><span class="p">,</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Express shipping"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">32</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/shipping_classes/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Small items"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Large items"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">33</span><span class="p">,</span>
|
|
<span class="ss">description: </span><span class="s2">"Express shipping"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">32</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/shipping_classes/batch"</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">"create"</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">34</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">"Small items"</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">"small-items"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">35</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">"Large items"</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">"large-items"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/35"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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="nl">"update"</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">33</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">"Express"</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">"express"</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">"Express shipping"</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">0</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/33"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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="nl">"delete"</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">32</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">"Priority"</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">"priority"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes/32"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/shipping_classes"</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><h1 id='product-tags'>Product tags</h1>
|
|
<p>The product tags API allows you to create, view, update, and delete individual, or a batch, of product tags.</p>
|
|
<h2 id='product-tag-properties'>Product tag 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Tag name. <i class="label label-info">required</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>An alphanumeric identifier for the resource unique to its type.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>HTML description of the resource.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>count</code></td>
|
|
<td>integer</td>
|
|
<td>Number of published products for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-product-tag'>Create a product tag</h2>
|
|
<p>This API helps you to create a new product tag.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/tags</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of how to create a product tag:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/products/tags <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">'{
|
|
"name": "Leather Shoes"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Leather Shoes</span><span class="dl">"</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="s2">products/tags</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Leather Shoes'</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="nf">post</span><span class="p">(</span><span class="s1">'products/tags'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Leather Shoes"</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/tags"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Leather Shoes"</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/tags"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</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">"Leather Shoes"</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">"leather-shoes"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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='retrieve-a-product-tag'>Retrieve a product tag</h2>
|
|
<p>This API lets you retrieve a product tag by ID.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/tags/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/tags/34 <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="s2">products/tags/34</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/tags/34'</span><span class="p">));</span> <span class="cp">?></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/tags/34"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/tags/34"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</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">"Leather Shoes"</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">"leather-shoes"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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='list-all-product-tags'>List all product tags</h2>
|
|
<p>This API lets you retrieve all product tag.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/products/tags</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/products/tags <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="s2">products/tags</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'products/tags'</span><span class="p">));</span> <span class="cp">?></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/tags"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/tags"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</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">"Leather Shoes"</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">"leather-shoes"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">35</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">"Oxford Shoes"</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">"oxford-shoes"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/35"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>name</code>. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>bool</td>
|
|
<td>Whether to hide resources not assigned to any products. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to resources assigned to a specific product.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to resources with a specific slug.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-product-tag'>Update a product tag</h2>
|
|
<p>This API lets you make changes to a product tag.</p>
|
|
<h3 id='http-request-2'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v1/products/tags/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v1/products/tags/34 <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">'{
|
|
"description": "Genuine leather."
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Genuine leather.</span><span class="dl">"</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="s2">products/tags/34</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'description'</span><span class="o">:</span> <span class="s1">'Genuine leather.'</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="nf">put</span><span class="p">(</span><span class="s1">'products/tags/34'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Genuine leather."</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/tags/34"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">description: </span><span class="s2">"Genuine leather."</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/tags/34"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</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">"Leather Shoes"</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">"leather-shoes"</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">"Genuine leather."</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">0</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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-a-product-tag'>Delete a product tag</h2>
|
|
<p>This API helps you delete a product tag.</p>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/products/tags/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/products/tags/34?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="s2">products/tags/34</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'products/tags/34'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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/tags/34"</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 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/tags/34"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</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">"Leather Shoes"</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">"leather-shoes"</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">"Genuine leather."</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">0</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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-parameters-2'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-product-tags'>Batch update product tags</h2>
|
|
<p>This API helps you to batch create, update and delete multiple product tags.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/products/tags/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/products/tags/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "Round toe"
|
|
},
|
|
{
|
|
"name": "Flat"
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 34,
|
|
"description": "Genuine leather."
|
|
}
|
|
],
|
|
"delete": [
|
|
35
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">Round toe</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Flat</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">update</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">id</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
|
|
<span class="na">description</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Genuine leather.</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">35</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="s2">products/tags/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Round toe'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Flat'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'update'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">34</span><span class="p">,</span>
|
|
<span class="s1">'description'</span> <span class="o">=></span> <span class="s1">'Genuine leather.'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">35</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="nf">post</span><span class="p">(</span><span class="s1">'products/tags/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"Round toe"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Flat"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"update"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
|
|
<span class="s">"description"</span><span class="p">:</span> <span class="s">"Genuine leather."</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">35</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/tags/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Round toe"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Flat"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">update: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">34</span><span class="p">,</span>
|
|
<span class="ss">description: </span><span class="s2">"Genuine leather."</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">35</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/tags/batch"</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">"create"</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">36</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">"Round toe"</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">"round-toe"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/36"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">37</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">"Flat"</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">"flat"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/37"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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="nl">"update"</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">34</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">"Leather Shoes"</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">"leather-shoes"</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">"Genuine leather."</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">0</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/34"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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="nl">"delete"</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">35</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">"Oxford Shoes"</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">"oxford-shoes"</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">"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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags/35"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/tags"</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><h1 id='reports'>Reports</h1>
|
|
<p>The reports API allows you to view all types of reports available.</p>
|
|
<h2 id='list-all-reports'>List all 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>/wp-json/wc/v1/reports</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">reports</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'reports'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sales"</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">"List of sales reports."</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports/sales"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports"</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="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"top_sellers"</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">"List of top sellers products."</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports/top_sellers"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports"</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><h2 id='retrieve-sales-report'>Retrieve sales report</h2>
|
|
<p>This API lets you retrieve and view a 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>/wp-json/wc/v1/reports/sales</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/reports/sales?date_min<span class="o">=</span>2016-05-03&date_max<span class="o">=</span>2016-05-04 <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="s2">reports/sales</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">date_min</span><span class="p">:</span> <span class="dl">"</span><span class="s2">2016-05-03</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">date_max</span><span class="p">:</span> <span class="dl">"</span><span class="s2">2016-05-04</span><span class="dl">"</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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">$query</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s1">'date_min'</span> <span class="o">=></span> <span class="s1">'2016-05-03'</span><span class="p">,</span>
|
|
<span class="s1">'date_max'</span> <span class="o">=></span> <span class="s1">'2016-05-04'</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="nf">get</span><span class="p">(</span><span class="s1">'reports/sales'</span><span class="p">,</span> <span class="nv">$query</span><span class="p">));</span>
|
|
<span class="cp">?></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?date_min=2016-05-03&date_max=2016-05-04"</span><span class="p">).</span><span class="n">json</span><span class="p">())</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight ruby tab-ruby"><code><span class="n">query</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">date_min: </span><span class="s2">"2016-05-03"</span><span class="p">,</span>
|
|
<span class="ss">date_max: </span><span class="s2">"2016-05-04"</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"reports/sales"</span><span class="p">,</span> <span class="n">query</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="p">{</span><span class="w">
|
|
</span><span class="nl">"total_sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"14.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"net_sales"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.00"</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">"2.00"</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">3</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">6</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">"total_refunds"</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_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">"2016-05-03"</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">"14.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">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">6</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">"10.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">"2016-05-04"</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="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="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">"about"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports"</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='sales-report-properties'>Sales report properties</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>total_sales</code></td>
|
|
<td>string</td>
|
|
<td>Gross sales in the period. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>net_sales</code></td>
|
|
<td>string</td>
|
|
<td>Net sales in the period. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>average_sales</code></td>
|
|
<td>string</td>
|
|
<td>Average net daily sales. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_orders</code></td>
|
|
<td>integer</td>
|
|
<td>Total of orders placed. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_items</code></td>
|
|
<td>integer</td>
|
|
<td>Total of items purchased. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_tax</code></td>
|
|
<td>string</td>
|
|
<td>Total charged for taxes. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_shipping</code></td>
|
|
<td>string</td>
|
|
<td>Total charged for shipping. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_refunds</code></td>
|
|
<td>number</td>
|
|
<td>Total of refunded orders. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total_discount</code></td>
|
|
<td>integer</td>
|
|
<td>Total of coupons used. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>totals_grouped_by</code></td>
|
|
<td>string</td>
|
|
<td>Group type. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>totals</code></td>
|
|
<td>array</td>
|
|
<td>Totals. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='available-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Default is <code>view</code>. Options: <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>period</code></td>
|
|
<td>string</td>
|
|
<td>Report period. Default is today's date. Options: <code>week</code>, <code>month</code>, <code>last_month</code> and <code>year</code></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 YYYY-MM-DD format.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_max</code></td>
|
|
<td>string</td>
|
|
<td>Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='retrieve-top-sellers-report'>Retrieve 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>/wp-json/wc/v1/reports/top_sellers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/reports/top_sellers?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="s2">reports/top_sellers</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">period</span><span class="p">:</span> <span class="dl">"</span><span class="s2">last_month</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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">$query</span> <span class="o">=</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="nb">print_r</span><span class="p">(</span><span class="nv">$woocommerce</span><span class="o">-></span><span class="nf">get</span><span class="p">(</span><span class="s1">'reports/top_sellers'</span><span class="p">,</span> <span class="nv">$query</span><span class="p">));</span>
|
|
<span class="cp">?></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/top_sellers?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 ruby tab-ruby"><code><span class="n">query</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">period: </span><span class="s2">"last_month"</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">woocommerce</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"reports/top_sellers"</span><span class="p">,</span> <span class="n">query</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="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="mi">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="mi">1</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">"about"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/37"</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="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="mi">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="mi">1</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">"about"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/reports"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/products/96"</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='top-sellers-report-properties'>Top sellers report properties</h4>
|
|
<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 title. <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">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Total number of purchases. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='available-parameters-2'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Default is <code>view</code>. Options: <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>period</code></td>
|
|
<td>string</td>
|
|
<td>Report period. Default is <code>week</code>. Options: <code>week</code>, <code>month</code>, <code>last_month</code> and <code>year</code></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 YYYY-MM-DD format.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_max</code></td>
|
|
<td>string</td>
|
|
<td>Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h1 id='tax-rates'>Tax rates</h1>
|
|
<p>The taxes API allows you to create, view, update, and delete individual tax rates, or a batch of tax rates.</p>
|
|
<h2 id='tax-rate-properties'>Tax rate 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>country</code></td>
|
|
<td>string</td>
|
|
<td>Country ISO 3166 code. See <a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">ISO 3166 Codes (Countries)</a> for more details</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>state</code></td>
|
|
<td>string</td>
|
|
<td>State code.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>postcode</code></td>
|
|
<td>string</td>
|
|
<td>Postcode/ZIP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>city</code></td>
|
|
<td>string</td>
|
|
<td>City name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rate</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Tax rate name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>priority</code></td>
|
|
<td>integer</td>
|
|
<td>Tax priority. Only 1 matching rate per priority will be used. To define multiple tax rates for a single area you need to specify a different priority per rate. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>compound</code></td>
|
|
<td>boolean</td>
|
|
<td>Whether or not this is a compound rate. Compound tax rates are applied on top of other tax rates. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping</code></td>
|
|
<td>boolean</td>
|
|
<td>Whether or not this tax rate also gets applied to shipping. Default is <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>integer</td>
|
|
<td>Indicates the order that will appear in queries.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class. Default is <code>standard</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-tax-rate'>Create a tax rate</h2>
|
|
<p>This API helps you to create a new tax rate.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/taxes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/taxes <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">'{
|
|
"country": "US",
|
|
"state": "AL",
|
|
"rate": "4",
|
|
"name": "State Tax",
|
|
"shipping": false
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">AL</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</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="s2">taxes</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'country'</span> <span class="o">=></span> <span class="s1">'US'</span><span class="p">,</span>
|
|
<span class="s1">'state'</span> <span class="o">=></span> <span class="s1">'AL'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</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="nf">post</span><span class="p">(</span><span class="s1">'taxes'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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">"state"</span><span class="p">:</span> <span class="s">"AL"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</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">"taxes"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"AL"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</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">"taxes"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">72</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/72"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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='retrieve-a-tax-rate'>Retrieve a tax rate</h2>
|
|
<p>This API lets you retrieve and view a specific tax rate by ID.</p>
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v1/taxes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/taxes/72 <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="s2">taxes/72</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'taxes/72'</span><span class="p">));</span> <span class="cp">?></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">"taxes/72"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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">"taxes/72"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">72</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/72"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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='list-all-tax-rates'>List all tax rates</h2>
|
|
<p>This API helps you to view all the tax rates.</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>/wp-json/wc/v1/taxes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/taxes <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="s2">taxes</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'taxes'</span><span class="p">));</span> <span class="cp">?></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">"taxes"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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">"taxes"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">72</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/72"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">73</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AZ"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.6000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/73"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">74</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AR"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/74"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">75</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">"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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/75"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">76</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CO"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.9000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/76"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">77</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CT"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.3500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/77"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">78</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DC"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.7500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/78"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">79</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"FL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/79"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">80</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/80"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">81</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GU"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/81"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>name</code>. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>class</code></td>
|
|
<td>string</td>
|
|
<td>Sort by tax class.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-tax-rate'>Update a tax rate</h2>
|
|
<p>This API lets you make changes to a tax rate.</p>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v1/taxes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v1/taxes/72 <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">'{
|
|
"name": "US Tax"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US Tax</span><span class="dl">"</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="s2">taxes/72</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'US Tax'</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="nf">put</span><span class="p">(</span><span class="s1">'taxes/72'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"US Tax"</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">"taxes/72"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"US Tax"</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">"taxes/72"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">72</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"US Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/72"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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-a-tax-rate'>Delete a tax rate</h2>
|
|
<p>This API helps you delete a tax rate.</p>
|
|
<h3 id='http-request-4'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/taxes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/taxes/72?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="s2">taxes/72</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'taxes/72'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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">"taxes/72"</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 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">"taxes/72"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">72</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"US Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/72"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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-parameters-2'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, as resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-tax-rates'>Batch update tax rates</h2>
|
|
<p>This API helps you to batch create, update and delete multiple tax rates.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-5'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/taxes/batch</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example batch creating all US taxes:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/taxes/batch <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">'{
|
|
"create": [
|
|
{
|
|
"country": "US",
|
|
"state": "AL",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 1
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "AZ",
|
|
"rate": "5.6000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 2
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "AR",
|
|
"rate": "6.5000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 3
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "CA",
|
|
"rate": "7.5000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 4
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "CO",
|
|
"rate": "2.9000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 5
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "CT",
|
|
"rate": "6.3500",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 6
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "DC",
|
|
"rate": "5.7500",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 7
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "FL",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 8
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "GA",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 9
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "GU",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 10
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "HI",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 11
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "ID",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 12
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "IL",
|
|
"rate": "6.2500",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 13
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "IN",
|
|
"rate": "7.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 14
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "IA",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 15
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "KS",
|
|
"rate": "6.1500",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 16
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "KY",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 17
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "LA",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 18
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "ME",
|
|
"rate": "5.5000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 19
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "MD",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 20
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "MA",
|
|
"rate": "6.2500",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 21
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "MI",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 22
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "MN",
|
|
"rate": "6.8750",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 23
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "MS",
|
|
"rate": "7.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 24
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "MO",
|
|
"rate": "4.2250",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 25
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "NE",
|
|
"rate": "5.5000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 26
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "NV",
|
|
"rate": "6.8500",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 27
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "NJ",
|
|
"rate": "7.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 28
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "NM",
|
|
"rate": "5.1250",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 29
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "NY",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 30
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "NC",
|
|
"rate": "4.7500",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 31
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "ND",
|
|
"rate": "5.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 32
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "OH",
|
|
"rate": "5.7500",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 33
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "OK",
|
|
"rate": "4.5000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 34
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "PA",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 35
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "PR",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 36
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "RI",
|
|
"rate": "7.0000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 37
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "SC",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 38
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "SD",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 39
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "TN",
|
|
"rate": "7.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 40
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "TX",
|
|
"rate": "6.2500",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 41
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "UT",
|
|
"rate": "5.9500",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 42
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "VT",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 43
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "VA",
|
|
"rate": "5.3000",
|
|
"name": "State Tax",
|
|
"shipping": false,
|
|
"order": 44
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "WA",
|
|
"rate": "6.5000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 45
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "WV",
|
|
"rate": "6.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 46
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "WI",
|
|
"rate": "5.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 47
|
|
},
|
|
{
|
|
"country": "US",
|
|
"state": "WY",
|
|
"rate": "4.0000",
|
|
"name": "State Tax",
|
|
"shipping": true,
|
|
"order": 48
|
|
}
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">AL</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">AZ</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.6000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">AR</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.5000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">3</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">CA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">7.5000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">4</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">CO</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">2.9000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">5</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">CT</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.3500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">6</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">DC</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.7500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">7</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">FL</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">8</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">GA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">GU</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">10</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">HI</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">11</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">ID</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">12</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">IL</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.2500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">13</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">IN</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">7.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">IA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">15</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">KS</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.1500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">16</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">KY</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">17</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">LA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">18</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">ME</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.5000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">19</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">MD</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">20</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">MA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.2500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">21</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">MI</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">22</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">MN</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.8750</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">23</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">MS</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">7.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">24</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">MO</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.2250</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">25</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">NE</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.5000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">26</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">NV</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.8500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">27</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">NJ</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">7.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">28</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">NM</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.1250</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">29</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">NY</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">30</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">NC</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.7500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">31</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">ND</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">32</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">OH</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.7500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">33</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">OK</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.5000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">34</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">PA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">35</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">PR</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">36</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">RI</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">7.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">37</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">SC</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">38</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">SD</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">39</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">TN</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">7.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">40</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">TX</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.2500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">41</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">UT</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.9500</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">42</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">VT</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">43</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">VA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.3000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">44</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">WA</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.5000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">45</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">WV</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">6.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">46</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">WI</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">5.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">47</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">country</span><span class="p">:</span> <span class="dl">"</span><span class="s2">US</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">state</span><span class="p">:</span> <span class="dl">"</span><span class="s2">WY</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">rate</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4.0000</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">State Tax</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">shipping</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">order</span><span class="p">:</span> <span class="mi">48</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="s2">taxes/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</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">'state'</span> <span class="o">=></span> <span class="s1">'AL'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">1</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'AZ'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.6000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">2</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'AR'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.5000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">3</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'CA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'7.5000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">4</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'CO'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'2.9000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">5</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'CT'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.3500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">6</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'DC'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.7500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">7</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'FL'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">8</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'GA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">9</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'GU'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">10</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'HI'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">11</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'ID'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">12</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'IL'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.2500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">13</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'IN'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'7.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">14</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'IA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">15</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'KS'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.1500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">16</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'KY'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">17</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'LA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">18</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'ME'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.5000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">19</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'MD'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">20</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'MA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.2500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">21</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'MI'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">22</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'MN'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.8750'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">23</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'MS'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'7.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">24</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'MO'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.2250'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">25</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'NE'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.5000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">26</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'NV'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.8500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">27</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'NJ'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'7.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">28</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'NM'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.1250'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">29</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'NY'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">30</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'NC'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.7500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">31</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'ND'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">32</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'OH'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.7500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">33</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'OK'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.5000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">34</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'PA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">35</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'PR'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">36</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'RI'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'7.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">37</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'SC'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">38</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'SD'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">39</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'TN'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'7.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">40</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'TX'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.2500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">41</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'UT'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.9500'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">42</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'VT'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">43</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'VA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.3000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">44</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'WA'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.5000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">45</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'WV'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'6.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">46</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'WI'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'5.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">47</span>
|
|
<span class="p">],</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">'state'</span> <span class="o">=></span> <span class="s1">'WY'</span><span class="p">,</span>
|
|
<span class="s1">'rate'</span> <span class="o">=></span> <span class="s1">'4.0000'</span><span class="p">,</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'State Tax'</span><span class="p">,</span>
|
|
<span class="s1">'shipping'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'order'</span> <span class="o">=></span> <span class="mi">48</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="nf">post</span><span class="p">(</span><span class="s1">'taxes/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</span><span class="p">:</span> <span class="p">[</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">"state"</span><span class="p">:</span> <span class="s">"AL"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">1</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"AZ"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.6000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">2</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"AR"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.5000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">3</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"CA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"7.5000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">4</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"CO"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"2.9000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">5</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"CT"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.3500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">6</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"DC"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.7500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">7</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"FL"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">8</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"GA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">9</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"GU"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">10</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"HI"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">11</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"ID"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">12</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"IL"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.2500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">13</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"IN"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"7.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">14</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"IA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">15</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"KS"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.1500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">16</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"KY"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">17</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"LA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">18</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"ME"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.5000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">19</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"MD"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">20</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"MA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.2500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">21</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"MI"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">22</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"MN"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.8750"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">23</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"MS"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"7.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">24</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"MO"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.2250"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">25</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"NE"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.5000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">26</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"NV"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.8500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">27</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"NJ"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"7.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">28</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.1250"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">29</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"NY"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">30</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"NC"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.7500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">31</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"ND"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">32</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"OH"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.7500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">33</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"OK"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.5000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">34</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"PA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">35</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"PR"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">36</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"RI"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"7.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">37</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"SC"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">38</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"SD"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">39</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"TN"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"7.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">40</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"TX"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.2500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">41</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"UT"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.9500"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">42</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"VT"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">43</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"VA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.3000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">44</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"WA"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.5000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">45</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"WV"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"6.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">46</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"WI"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"5.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">47</span>
|
|
<span class="p">},</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">"state"</span><span class="p">:</span> <span class="s">"WY"</span><span class="p">,</span>
|
|
<span class="s">"rate"</span><span class="p">:</span> <span class="s">"4.0000"</span><span class="p">,</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"State Tax"</span><span class="p">,</span>
|
|
<span class="s">"shipping"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"order"</span><span class="p">:</span> <span class="mi">48</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">"taxes/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"AL"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">1</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"AZ"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.6000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">2</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"AR"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.5000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">3</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"7.5000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">4</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CO"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"2.9000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">5</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"CT"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.3500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">6</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"DC"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.7500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">7</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"FL"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">8</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"GA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">9</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"GU"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">10</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"HI"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">11</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"ID"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">12</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"IL"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.2500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">13</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"IN"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"7.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">14</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"IA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">15</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"KS"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.1500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">16</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"KY"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">17</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"LA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">18</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"ME"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.5000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">19</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"MD"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">20</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"MA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.2500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">21</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"MI"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">22</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"MN"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.8750"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">23</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"MS"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"7.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">24</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"MO"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.2250"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">25</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"NE"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.5000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">26</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"NV"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.8500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">27</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"NJ"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"7.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">28</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"NM"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.1250"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">29</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"NY"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">30</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"NC"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.7500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">31</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"ND"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">32</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"OH"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.7500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">33</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"OK"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.5000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">34</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"PA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">35</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"PR"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">36</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"RI"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"7.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">37</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"SC"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">38</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"SD"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">39</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"TN"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"7.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">40</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"TX"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.2500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">41</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"UT"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.9500"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">42</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"VT"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">43</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"VA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.3000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">false</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">44</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"WA"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.5000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">45</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"WV"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"6.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">46</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"WI"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"5.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">47</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">country: </span><span class="s2">"US"</span><span class="p">,</span>
|
|
<span class="ss">state: </span><span class="s2">"WY"</span><span class="p">,</span>
|
|
<span class="ss">rate: </span><span class="s2">"4.0000"</span><span class="p">,</span>
|
|
<span class="ss">name: </span><span class="s2">"State Tax"</span><span class="p">,</span>
|
|
<span class="ss">shipping: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">order: </span><span class="mi">48</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">"taxes/batch"</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">"create"</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">72</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/72"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">73</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AZ"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.6000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/73"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">74</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AR"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/74"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">75</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">"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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/75"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">76</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CO"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.9000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/76"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">77</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CT"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.3500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/77"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">78</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DC"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.7500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/78"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">79</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"FL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/79"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">80</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/80"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">81</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GU"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/81"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">82</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"HI"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/82"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">83</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ID"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/83"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">84</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"IL"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.2500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/84"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">85</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">"state"</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">"postcode"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/85"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">86</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"IA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/86"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">87</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"KS"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.1500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">16</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/87"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">88</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"KY"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">17</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/88"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">89</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"LA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/89"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ME"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/90"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">91</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MD"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/91"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">92</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.2500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">21</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/92"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MI"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/93"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">94</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MN"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.8750"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">23</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/94"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">95</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MS"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">24</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/95"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"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">"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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MO"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.2250"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">25</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/96"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">97</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NE"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">26</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/97"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">98</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NV"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.8500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">27</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/98"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">99</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NJ"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/99"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NM"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.1250"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">29</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/100"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">101</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NY"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/101"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">102</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NC"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.7500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</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">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/102"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">103</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ND"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/103"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">104</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OH"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.7500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">33</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/104"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">105</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">"state"</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">"postcode"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">34</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/105"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">106</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">35</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/106"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">107</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PR"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">36</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/107"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">108</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"RI"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">37</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/108"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">109</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SC"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">38</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/109"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">110</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SD"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">39</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/110"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">111</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TN"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/111"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">112</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TX"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.2500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">41</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/112"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">113</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"UT"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.9500"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/113"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">114</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VT"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">43</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/114"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">115</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.3000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">44</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/115"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">116</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WA"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.5000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">45</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/116"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">117</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WV"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">46</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/117"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">118</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WI"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/118"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">119</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WY"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"rate"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.0000"</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">"State Tax"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"priority"</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">"compound"</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">"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">"order"</span><span class="p">:</span><span class="w"> </span><span class="mi">48</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"class"</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">"_links"</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="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/119"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes"</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><h1 id='tax-classes'>Tax classes</h1>
|
|
<p>The tax classes API allows you to create, view, and delete individual tax classes.</p>
|
|
<h2 id='tax-class-properties'>Tax class properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Tax class name. <i class="label label-info">required</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-tax-class'>Create a tax class</h2>
|
|
<p>This API helps you to create a new tax class.</p>
|
|
<h3 id='http-request'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/taxes/classes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/taxes/classes <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">'{
|
|
"name": "Zero Rate"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Zero Rate</span><span class="dl">"</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="s2">taxes/classes</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Zero Rate'</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="nf">post</span><span class="p">(</span><span class="s1">'taxes/classes'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Zero Rate"</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">"taxes/classes"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Zero Rate"</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">"taxes/classes"</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"zero-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">"Zero Rate"</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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/classes"</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='list-all-tax-classes'>List all tax classes</h2>
|
|
<p>This API helps you to view all tax classes.</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>/wp-json/wc/v1/taxes/classes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/taxes/classes <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="s2">taxes/classes</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'taxes/classes'</span><span class="p">));</span> <span class="cp">?></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">"taxes/classes"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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">"taxes/classes"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"slug"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard Rate"</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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/classes"</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="nl">"slug"</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">"Reduced Rate"</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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/classes"</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="nl">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"zero-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">"Zero Rate"</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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/classes"</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><h2 id='delete-a-tax-class'>Delete a tax class</h2>
|
|
<p>This API helps you delete a tax class.</p>
|
|
|
|
<aside class="warning">
|
|
This also will delete all tax rates from the selected class.
|
|
</aside>
|
|
<h3 id='http-request-3'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-delete">DELETE</i>
|
|
<h6>/wp-json/wc/v1/taxes/classes/<slug></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v1/taxes/classes/zero-rate?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="s2">taxes/classes/zero-rate</span><span class="dl">"</span><span class="p">,</span> <span class="p">{</span>
|
|
<span class="na">force</span><span class="p">:</span> <span class="kc">true</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'taxes/classes/zero-rate'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'force'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">]));</span> <span class="cp">?></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">"taxes/classes/zero-rate"</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 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">"taxes/classes/zero-rate"</span><span class="p">,</span> <span class="ss">force: </span><span class="kp">true</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">"slug"</span><span class="p">:</span><span class="w"> </span><span class="s2">"zero-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">"Zero Rate"</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">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/taxes/classes"</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-parameters'>Available parameters</h4>
|
|
<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>Required to be <code>true</code>, since this resource does not support trashing.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h1 id='webhooks'>Webhooks</h1>
|
|
<p>The webhooks API allows you to create, view, update, and delete individual, or a batch, of webhooks.</p>
|
|
|
|
<p>Webhooks can be managed via the WooCommerce settings screen or by using the REST API endpoints. The <code>WC_Webhook</code> class manages all data storage and retrieval of the webhook custom post type, as well as enqueuing webhook actions and processing/delivering/logging webhooks. On <code>woocommerce_init</code>, active webhooks are loaded.</p>
|
|
|
|
<p>Each webhook has:</p>
|
|
|
|
<ul>
|
|
<li><code>status</code>: active (delivers payload), paused (delivery paused by admin), disabled (delivery paused by failure).</li>
|
|
<li><code>topic</code>: determines which resource events the webhook is triggered for.</li>
|
|
<li><code>delivery URL</code>: URL where the payload is delivered, must be HTTP or HTTPS.</li>
|
|
<li><code>secret</code>: 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><code>hooks</code>: 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>Coupons: <code>coupon.created</code>, <code>coupon.updated</code> and <code>coupon.deleted</code>.</li>
|
|
<li>Customers: <code>customer.created</code>, <code>customer.updated</code> and <code>customer.deleted</code>.</li>
|
|
<li>Orders: <code>order.created</code>, <code>order.updated</code> and <code>order.deleted</code>.</li>
|
|
<li>Products: <code>product.created</code>, <code>product.updated</code> and <code>product.deleted</code>.</li>
|
|
</ul>
|
|
|
|
<p>Custom topics can also be used which map to a single hook name, 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 performed 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='visual-interface'>Visual interface</h3>
|
|
<p>You can find the Webhooks interface going to "WooCommerce" > "Settings" > "API" > "Webhooks", see our <a href="https://docs.woocommerce.com/document/webhooks/">Visual Webhooks docs</a> for more details.</p>
|
|
<h2 id='webhook-properties'>Webhook 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>Unique identifier for the resource. <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. Default is <code>Webhook created on <date></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Webhook status. Default is <code>active</code>. Options <code>active</code> (delivers payload), <code>paused</code> (does not deliver), or <code>disabled</code> (does not deliver due delivery failures).</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>. <i class="label label-info">required</i></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. <i class="label label-info">required</i></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>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>UTC DateTime when the webhook was created <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified</code></td>
|
|
<td>date-time</td>
|
|
<td>UTC DateTime when the webhook was last updated <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='webhooks-delivery-properties'>Webhooks 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>Unique identifier for the resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>duration</code></td>
|
|
<td>string</td>
|
|
<td>The delivery duration, in seconds. <i class="label label-info">read-only</i></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. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>request_url</code></td>
|
|
<td>string</td>
|
|
<td>The URL where the webhook was delivered. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>request_headers</code></td>
|
|
<td>array</td>
|
|
<td>Request headers. See <a href="#request-header-properties">Request Headers Attributes</a> for more details. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>request_body</code></td>
|
|
<td>string</td>
|
|
<td>Request body. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_code</code></td>
|
|
<td>string</td>
|
|
<td>The HTTP response code from the receiving server. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_message</code></td>
|
|
<td>string</td>
|
|
<td>The HTTP response message from the receiving server. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_headers</code></td>
|
|
<td>array</td>
|
|
<td>Array of the response headers from the receiving server. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>response_body</code></td>
|
|
<td>string</td>
|
|
<td>The response body from the receiving server. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the webhook delivery was logged, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='request-header-properties'>Request header 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, default is "WooCommerce/{version} Hookshot (WordPress/{version})". <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Content-Type</code></td>
|
|
<td>string</td>
|
|
<td>The request content-type, default is "application/json". <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Topic</code></td>
|
|
<td>string</td>
|
|
<td>The webhook topic. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Resource</code></td>
|
|
<td>string</td>
|
|
<td>The webhook resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Event</code></td>
|
|
<td>string</td>
|
|
<td>The webhook event. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Signature</code></td>
|
|
<td>string</td>
|
|
<td>A base64 encoded HMAC-SHA256 hash of the payload. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-ID</code></td>
|
|
<td>integer</td>
|
|
<td>The webhook's ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>X-WC-Webhook-Delivery-ID</code></td>
|
|
<td>integer</td>
|
|
<td>The delivery ID. <i class="label label-info">read-only</i></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>/wp-json/wc/v1/webhooks</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v1/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">'{
|
|
"name": "Order updated",
|
|
"topic": "order.updated",
|
|
"delivery_url": "http://requestb.in/1g0sxmo1"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Order updated</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">topic</span><span class="p">:</span> <span class="dl">"</span><span class="s2">order.updated</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="s2">http://requestb.in/1g0sxmo1</span><span class="dl">"</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="s2">webhooks</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Order updated'</span><span class="p">,</span>
|
|
<span class="s1">'topic'</span> <span class="o">=></span> <span class="s1">'order.updated'</span><span class="p">,</span>
|
|
<span class="s1">'delivery_url'</span> <span class="o">=></span> <span class="s1">'http://requestb.in/1g0sxmo1'</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="nf">post</span><span class="p">(</span><span class="s1">'webhooks'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Order updated"</span><span class="p">,</span>
|
|
<span class="s">"topic"</span><span class="p">:</span> <span class="s">"order.updated"</span><span class="p">,</span>
|
|
<span class="s">"delivery_url"</span><span class="p">:</span> <span class="s">"http://requestb.in/1g0sxmo1"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Order updated"</span><span class="p">,</span>
|
|
<span class="ss">topic: </span><span class="s2">"order.updated"</span><span class="p">,</span>
|
|
<span class="ss">delivery_url: </span><span class="s2">"http://requestb.in/1g0sxmo1"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">142</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">"Order updated"</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.updated"</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">"updated"</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_process_shop_order_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_edit_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_edit_status"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_status_changed"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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='retrieve-a-webhook'>Retrieve 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>/wp-json/wc/v1/webhooks/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/webhooks/142 <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="s2">webhooks/142</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'webhooks/142'</span><span class="p">));</span> <span class="cp">?></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/142"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/142"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">142</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">"Order updated"</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.updated"</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">"updated"</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_process_shop_order_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_edit_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_edit_status"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_status_changed"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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='list-all-webhooks'>List all 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>/wp-json/wc/v1/webhooks</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/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="s2">webhooks</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'webhooks'</span><span class="p">));</span> <span class="cp">?></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 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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">143</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">"Customer created"</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">"customer.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">"customer"</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">"user_register"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_created_customer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_create_customer"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/143"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">142</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">"Order updated"</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.updated"</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">"updated"</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_process_shop_order_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_edit_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_edit_status"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_status_changed"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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-parameters'>Available parameters</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>context</code></td>
|
|
<td>string</td>
|
|
<td>Scope under which the request is made; determines fields present in response. Options: <code>view</code> and <code>edit</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>search</code></td>
|
|
<td>string</td>
|
|
<td>Limit results to those matching a string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>after</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published after a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>before</code></td>
|
|
<td>string</td>
|
|
<td>Limit response to resources published before a given ISO8601 compliant date.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dates_are_gmt</code></td>
|
|
<td>boolean</td>
|
|
<td>Interpret <code>after</code> and <code>before</code> as UTC dates when <code>true</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude</code></td>
|
|
<td>string</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td>integer</td>
|
|
<td>Offset the result set by a specific number of items.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>string</td>
|
|
<td>Order sort attribute ascending or descending. Default is <code>asc</code>. Options: <code>asc</code> and <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Default is <code>date</code>, Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to posts with a specific slug.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to webhooks assigned a specific status. Default is <code>all</code>. Options: <code>all</code>, <code>active</code>, <code>paused</code> and <code>disabled</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>/wp-json/wc/v1/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/wp-json/wc/v1/webhook/142 <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">'{
|
|
"status": "paused"
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">status</span><span class="p">:</span> <span class="dl">"</span><span class="s2">paused</span><span class="dl">"</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="s2">webhooks/142</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'status'</span> <span class="o">=></span> <span class="s1">'paused'</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="nf">put</span><span class="p">(</span><span class="s1">'webhooks/142'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</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="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/142"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">status: </span><span class="s2">"paused"</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/142"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">142</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">"Order updated"</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">"order.updated"</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">"updated"</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_process_shop_order_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_edit_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_edit_status"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_status_changed"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:30:12"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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-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>/wp-json/wc/v1/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/wp-json/wc/v1/webhooks/142 <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="s2">webhooks/142</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nb">delete</span><span class="p">(</span><span class="s1">'webhooks/142'</span><span class="p">));</span> <span class="cp">?></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/142"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/142"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">142</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">"Order updated"</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">"order.updated"</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">"updated"</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_process_shop_order_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_edit_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_edit_status"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_order_status_changed"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:30:12"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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-parameters-2'>Available parameters</h4>
|
|
<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 webhook, Defaults is <code>false</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='batch-update-webhooks'>Batch update webhooks</h2>
|
|
<p>This API helps you to batch create, update and delete multiple webhooks.</p>
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
<h3 id='http-request-6'>HTTP request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v1/webhooks/batch</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com//wp-json/wc/v1/webhooks/batch <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">'{
|
|
"create": [
|
|
{
|
|
"name": "Coupon created",
|
|
"topic": "coupon.created",
|
|
"delivery_url": "http://requestb.in/1g0sxmo1"
|
|
},
|
|
{
|
|
"name": "Customer deleted",
|
|
"topic": "customer.deleted",
|
|
"delivery_url": "http://requestb.in/1g0sxmo1"
|
|
}
|
|
],
|
|
"delete": [
|
|
143
|
|
]
|
|
}'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">const</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="na">create</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="s2">Round toe</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">topic</span><span class="p">:</span> <span class="dl">"</span><span class="s2">coupon.created</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="s2">http://requestb.in/1g0sxmo1</span><span class="dl">"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Customer deleted</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">topic</span><span class="p">:</span> <span class="dl">"</span><span class="s2">customer.deleted</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="s2">http://requestb.in/1g0sxmo1</span><span class="dl">"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">143</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="s2">webhooks/batch</span><span class="dl">"</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="p">[</span>
|
|
<span class="s1">'create'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Round toe'</span><span class="p">,</span>
|
|
<span class="s1">'topic'</span> <span class="o">=></span> <span class="s1">'coupon.created'</span><span class="p">,</span>
|
|
<span class="s1">'delivery_url'</span> <span class="o">=></span> <span class="s1">'http://requestb.in/1g0sxmo1'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'Customer deleted'</span><span class="p">,</span>
|
|
<span class="s1">'topic'</span> <span class="o">=></span> <span class="s1">'customer.deleted'</span><span class="p">,</span>
|
|
<span class="s1">'delivery_url'</span> <span class="o">=></span> <span class="s1">'http://requestb.in/1g0sxmo1'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">],</span>
|
|
<span class="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">143</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="nf">post</span><span class="p">(</span><span class="s1">'webhooks/batch'</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 python tab-python"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">"create"</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">"Round toe"</span><span class="p">,</span>
|
|
<span class="s">"topic"</span><span class="p">:</span> <span class="s">"coupon.created"</span><span class="p">,</span>
|
|
<span class="s">"delivery_url"</span><span class="p">:</span> <span class="s">"http://requestb.in/1g0sxmo1"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"name"</span><span class="p">:</span> <span class="s">"Customer deleted"</span><span class="p">,</span>
|
|
<span class="s">"topic"</span><span class="p">:</span> <span class="s">"customer.deleted"</span><span class="p">,</span>
|
|
<span class="s">"delivery_url"</span><span class="p">:</span> <span class="s">"http://requestb.in/1g0sxmo1"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="s">"delete"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">143</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/batch"</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 ruby tab-ruby"><code><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="ss">create: </span><span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Round toe"</span><span class="p">,</span>
|
|
<span class="ss">topic: </span><span class="s2">"coupon.created"</span><span class="p">,</span>
|
|
<span class="ss">delivery_url: </span><span class="s2">"http://requestb.in/1g0sxmo1"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">name: </span><span class="s2">"Customer deleted"</span><span class="p">,</span>
|
|
<span class="ss">topic: </span><span class="s2">"customer.deleted"</span><span class="p">,</span>
|
|
<span class="ss">delivery_url: </span><span class="s2">"http://requestb.in/1g0sxmo1"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">143</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/batch"</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">"create"</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">146</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">"Coupon created"</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">"coupon.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">"coupon"</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_process_shop_coupon_meta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_create_coupon"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-24T22:56:26"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-24T22:56:26"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/146"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">147</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">"Customer deleted"</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">"customer.deleted"</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">"customer"</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">"deleted"</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">"delete_user"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-24T22:56:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-24T22:56:30"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/147"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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="nl">"delete"</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">143</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 May 24, 2016 @ 03:20 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">"customer.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">"customer"</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">"user_register"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_created_customer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"woocommerce_api_create_customer"</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/1g0sxmo1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-15T20:17:52"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/143"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks"</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><h2 id='retrieve-webhook-delivery'>Retrieve webhook 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>/wp-json/wc/v1/webhooks/<id>/deliveries/<delivery_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/webhooks/142/deliveries/54 <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="s2">webhooks/142/deliveries/54</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'webhooks/142/deliveries/54'</span><span class="p">));</span> <span class="cp">?></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/142/deliveries/54"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/142/deliveries/54"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">54</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.40888"</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/1g0sxmo1"</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.6.0 Hookshot (WordPress/4.5.2)"</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-Source"</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">"X-WC-Webhook-Topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"order.updated"</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">"order"</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">"updated"</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">"J72iu7hL93aUt2dFnyOBoBypwbmP6nt6Aor33nnOHxU="</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">142</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">54</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">order</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:118,</span><span class="se">\"</span><span class="s2">order_number</span><span class="se">\"</span><span class="s2">:118,</span><span class="se">\"</span><span class="s2">order_key</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">wc_order_5728e9a347a2d</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">created_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-03T18:10:00Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">updated_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-16T03:30:30Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">completed_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-16T03:29:19Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">status</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">completed</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">currency</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">BRL</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">14.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">subtotal</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_line_items_quantity</span><span class="se">\"</span><span class="s2">:2,</span><span class="se">\"</span><span class="s2">total_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_shipping</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">10.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">cart_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">shipping_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_discount</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">shipping_methods</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Flat Rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">payment_details</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">method_id</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">bacs</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">method_title</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Direct Bank Transfer</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">paid</span><span class="se">\"</span><span class="s2">:true},</span><span class="se">\"</span><span class="s2">billing_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">phone</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">(555) 555-5555</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">shipping_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">note</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_ip</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">127.0.0.1</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_user_agent</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">curl/7.47.0</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_id</span><span class="se">\"</span><span class="s2">:0,</span><span class="se">\"</span><span class="s2">view_order_url</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">http://example.com/my-account/view-order/118</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">line_items</span><span class="se">\"</span><span class="s2">:[{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:8,</span><span class="se">\"</span><span class="s2">subtotal</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">subtotal_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">price</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">quantity</span><span class="se">\"</span><span class="s2">:2,</span><span class="se">\"</span><span class="s2">tax_class</span><span class="se">\"</span><span class="s2">:null,</span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Woo Single #2</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">product_id</span><span class="se">\"</span><span class="s2">:99,</span><span class="se">\"</span><span class="s2">sku</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">12345</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">meta</span><span class="se">\"</span><span class="s2">:[]}],</span><span class="se">\"</span><span class="s2">shipping_lines</span><span class="se">\"</span><span class="s2">:[{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:9,</span><span class="se">\"</span><span class="s2">method_id</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">flat_rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">method_title</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Flat Rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">10.00</span><span class="se">\"</span><span class="s2">}],</span><span class="se">\"</span><span class="s2">tax_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">fee_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">coupon_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">is_vat_exempt</span><span class="se">\"</span><span class="s2">:false,</span><span class="se">\"</span><span class="s2">customer</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:0,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">billing_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">phone</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">(555) 555-5555</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">shipping_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</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/19.3.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">"Tue, 16 May 2016 03:30:31 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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-16T03:30:31"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142/deliveries/54"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142/deliveries"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</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="#webhooks-delivery-properties">Webhooks Delivery properties</a> for more details on this response.
|
|
</aside>
|
|
<h2 id='list-all-webhook-deliveries'>List all webhook 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>/wp-json/wc/v1/webhooks/<id>/deliveries</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v1/webhooks/142/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="s2">webhooks/142/deliveries</span><span class="dl">"</span><span class="p">)</span>
|
|
<span class="p">.</span><span class="nx">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=></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">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">})</span>
|
|
<span class="p">.</span><span class="k">catch</span><span class="p">((</span><span class="nx">error</span><span class="p">)</span> <span class="o">=></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">error</span><span class="p">.</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</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="nf">get</span><span class="p">(</span><span class="s1">'webhooks/142/deliveries'</span><span class="p">));</span> <span class="cp">?></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/142/deliveries"</span><span class="p">).</span><span class="n">json</span><span class="p">())</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/142/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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">54</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.40888"</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/1g0sxmo1"</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.6.0 Hookshot (WordPress/4.5.2)"</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-Source"</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">"X-WC-Webhook-Topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"order.updated"</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">"order"</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">"updated"</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">"J72iu7hL93aUt2dFnyOBoBypwbmP6nt6Aor33nnOHxU="</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">142</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">54</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">order</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:118,</span><span class="se">\"</span><span class="s2">order_number</span><span class="se">\"</span><span class="s2">:118,</span><span class="se">\"</span><span class="s2">order_key</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">wc_order_5728e9a347a2d</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">created_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-03T18:10:00Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">updated_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-16T03:30:30Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">completed_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-16T03:29:19Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">status</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">completed</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">currency</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">BRL</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">14.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">subtotal</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_line_items_quantity</span><span class="se">\"</span><span class="s2">:2,</span><span class="se">\"</span><span class="s2">total_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_shipping</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">10.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">cart_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">shipping_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_discount</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">shipping_methods</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Flat Rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">payment_details</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">method_id</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">bacs</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">method_title</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Direct Bank Transfer</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">paid</span><span class="se">\"</span><span class="s2">:true},</span><span class="se">\"</span><span class="s2">billing_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">phone</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">(555) 555-5555</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">shipping_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">note</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_ip</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">127.0.0.1</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_user_agent</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">curl/7.47.0</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_id</span><span class="se">\"</span><span class="s2">:0,</span><span class="se">\"</span><span class="s2">view_order_url</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">http://example.com/my-account/view-order/118</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">line_items</span><span class="se">\"</span><span class="s2">:[{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:8,</span><span class="se">\"</span><span class="s2">subtotal</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">subtotal_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">price</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">quantity</span><span class="se">\"</span><span class="s2">:2,</span><span class="se">\"</span><span class="s2">tax_class</span><span class="se">\"</span><span class="s2">:null,</span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Woo Single #2</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">product_id</span><span class="se">\"</span><span class="s2">:99,</span><span class="se">\"</span><span class="s2">sku</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">12345</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">meta</span><span class="se">\"</span><span class="s2">:[]}],</span><span class="se">\"</span><span class="s2">shipping_lines</span><span class="se">\"</span><span class="s2">:[{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:9,</span><span class="se">\"</span><span class="s2">method_id</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">flat_rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">method_title</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Flat Rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">10.00</span><span class="se">\"</span><span class="s2">}],</span><span class="se">\"</span><span class="s2">tax_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">fee_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">coupon_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">is_vat_exempt</span><span class="se">\"</span><span class="s2">:false,</span><span class="se">\"</span><span class="s2">customer</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:0,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">billing_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">phone</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">(555) 555-5555</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">shipping_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</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/19.3.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">"Tue, 16 May 2016 03:30:31 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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-16T03:30:31"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142/deliveries/54"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142/deliveries"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">53</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.7615"</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/1g0sxmo1"</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.6.0 Hookshot (WordPress/4.5.2)"</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-Source"</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">"X-WC-Webhook-Topic"</span><span class="p">:</span><span class="w"> </span><span class="s2">"order.updated"</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">"order"</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">"updated"</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">"Z996ccyueeoqdXZFq2ND2ETpsPGrXmWKj+yvQ0c2N1w="</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">142</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">53</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">order</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:118,</span><span class="se">\"</span><span class="s2">order_number</span><span class="se">\"</span><span class="s2">:118,</span><span class="se">\"</span><span class="s2">order_key</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">wc_order_5728e9a347a2d</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">created_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-03T18:10:00Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">updated_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-16T03:29:13Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">completed_at</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2016-05-16T03:29:19Z</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">status</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">completed</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">currency</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">BRL</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">14.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">subtotal</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_line_items_quantity</span><span class="se">\"</span><span class="s2">:2,</span><span class="se">\"</span><span class="s2">total_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_shipping</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">10.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">cart_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">shipping_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_discount</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">shipping_methods</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Flat Rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">payment_details</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">method_id</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">bacs</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">method_title</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Direct Bank Transfer</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">paid</span><span class="se">\"</span><span class="s2">:true},</span><span class="se">\"</span><span class="s2">billing_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">phone</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">(555) 555-5555</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">shipping_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">note</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_ip</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">127.0.0.1</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_user_agent</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">curl/7.47.0</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">customer_id</span><span class="se">\"</span><span class="s2">:0,</span><span class="se">\"</span><span class="s2">view_order_url</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">http://example.com/my-account/view-order/118</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">line_items</span><span class="se">\"</span><span class="s2">:[{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:8,</span><span class="se">\"</span><span class="s2">subtotal</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">subtotal_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">4.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total_tax</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">0.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">price</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">2.00</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">quantity</span><span class="se">\"</span><span class="s2">:2,</span><span class="se">\"</span><span class="s2">tax_class</span><span class="se">\"</span><span class="s2">:null,</span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Woo Single #2</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">product_id</span><span class="se">\"</span><span class="s2">:99,</span><span class="se">\"</span><span class="s2">sku</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">12345</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">meta</span><span class="se">\"</span><span class="s2">:[]}],</span><span class="se">\"</span><span class="s2">shipping_lines</span><span class="se">\"</span><span class="s2">:[{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:9,</span><span class="se">\"</span><span class="s2">method_id</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">flat_rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">method_title</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Flat Rate</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">total</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">10.00</span><span class="se">\"</span><span class="s2">}],</span><span class="se">\"</span><span class="s2">tax_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">fee_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">coupon_lines</span><span class="se">\"</span><span class="s2">:[],</span><span class="se">\"</span><span class="s2">is_vat_exempt</span><span class="se">\"</span><span class="s2">:false,</span><span class="se">\"</span><span class="s2">customer</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">id</span><span class="se">\"</span><span class="s2">:0,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">billing_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">email</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">john.doe@claudiosmweb.com</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">phone</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">(555) 555-5555</span><span class="se">\"</span><span class="s2">},</span><span class="se">\"</span><span class="s2">shipping_address</span><span class="se">\"</span><span class="s2">:{</span><span class="se">\"</span><span class="s2">first_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">John</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">last_name</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">Doe</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">company</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_1</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">969 Market</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">address_2</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">city</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">San Francisco</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">state</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">CA</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">postcode</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">94103</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">country</span><span class="se">\"</span><span class="s2">:</span><span class="se">\"</span><span class="s2">US</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/19.3.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">"Tue, 16 May 2016 03:29:20 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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-05-16T03:29:19"</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">"self"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142/deliveries/53"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"collection"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142/deliveries"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"up"</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">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v1/webhooks/142"</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>
|
|
</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="php">PHP</a>
|
|
<a href="#" data-language-name="python">Python</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 REST API v1 which is deprecated since WooCommerce 3.0. <a href="http://woocommerce.github.io/woocommerce-rest-api-docs/">Please use the latest REST API version</a>.
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|
