mirror of
https://gh.wpcy.net/https://github.com/woocommerce/woocommerce-rest-api-docs.git
synced 2026-04-24 04:42:50 +08:00
39265 lines
4 MiB
39265 lines
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 v2</title>
|
|
|
|
<link rel="icon" href="images/favicon-32x32-83e66af5.png" sizes="32x32" />
|
|
<link rel="icon" href="images/favicon-192x192-1360b554.png" sizes="192x192" />
|
|
<link rel="apple-touch-icon-precomposed" href="images/favicon-180x180-11109413.png" />
|
|
<meta name="msapplication-TileImage" content="images/favicon-270x270-16b8f5e2.png" />
|
|
|
|
<style>
|
|
.highlight table td { padding: 5px; }
|
|
.highlight table pre { margin: 0; }
|
|
.highlight .gh {
|
|
color: #999999;
|
|
}
|
|
.highlight .sr {
|
|
color: #f6aa11;
|
|
}
|
|
.highlight .go {
|
|
color: #888888;
|
|
}
|
|
.highlight .gp {
|
|
color: #555555;
|
|
}
|
|
.highlight .gs {
|
|
}
|
|
.highlight .gu {
|
|
color: #aaaaaa;
|
|
}
|
|
.highlight .nb {
|
|
color: #f6aa11;
|
|
}
|
|
.highlight .cm {
|
|
color: #75715e;
|
|
}
|
|
.highlight .cp {
|
|
color: #75715e;
|
|
}
|
|
.highlight .c1 {
|
|
color: #75715e;
|
|
}
|
|
.highlight .cs {
|
|
color: #75715e;
|
|
}
|
|
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
|
|
color: #75715e;
|
|
}
|
|
.highlight .err {
|
|
color: #960050;
|
|
}
|
|
.highlight .gr {
|
|
color: #960050;
|
|
}
|
|
.highlight .gt {
|
|
color: #960050;
|
|
}
|
|
.highlight .gd {
|
|
color: #49483e;
|
|
}
|
|
.highlight .gi {
|
|
color: #49483e;
|
|
}
|
|
.highlight .ge {
|
|
color: #49483e;
|
|
}
|
|
.highlight .kc {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .kd {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .kr {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .no {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .kt {
|
|
color: #66d9ef;
|
|
}
|
|
.highlight .mf {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .mh {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .il {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .mi {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .mo {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .m, .highlight .mb, .highlight .mx {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .sc {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .se {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .ss {
|
|
color: #ae81ff;
|
|
}
|
|
.highlight .sd {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .s2 {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .sb {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .sh {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .si {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .sx {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .s1 {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .s, .highlight .sa, .highlight .dl {
|
|
color: #e6db74;
|
|
}
|
|
.highlight .na {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .nc {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .nd {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .ne {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .nf, .highlight .fm {
|
|
color: #a6e22e;
|
|
}
|
|
.highlight .vc {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .nn {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .nl {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .ni {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .bp {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .vg {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .vi {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .nv, .highlight .vm {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .w {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .n, .highlight .py, .highlight .nx {
|
|
color: #ffffff;
|
|
background-color: #272822;
|
|
}
|
|
.highlight .ow {
|
|
color: #f92672;
|
|
}
|
|
.highlight .nt {
|
|
color: #f92672;
|
|
}
|
|
.highlight .k, .highlight .kv {
|
|
color: #f92672;
|
|
}
|
|
.highlight .kn {
|
|
color: #f92672;
|
|
}
|
|
.highlight .kp {
|
|
color: #f92672;
|
|
}
|
|
.highlight .o {
|
|
color: #f92672;
|
|
}
|
|
</style>
|
|
<link href="stylesheets/screen-0b45e388.css" rel="stylesheet" media="screen" />
|
|
<link href="stylesheets/print-c427a123.css" rel="stylesheet" media="print" />
|
|
<script src="javascripts/all_nosearch-c275c2f6.js"></script>
|
|
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-8KCYZ2CYMS"></script>
|
|
<script>
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag('js', new Date());
|
|
|
|
gtag('config', 'G-8KCYZ2CYMS', {
|
|
'content_group' : 'WooCommerce REST API Docs',
|
|
});
|
|
</script>
|
|
</head>
|
|
|
|
<body class="wp-api-v2" 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="#order-refund-properties" class="toc-h2 toc-link" data-title="Order refund properties">Order 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="#product-review-properties" class="toc-h2 toc-link" data-title="Product review properties">Product review properties</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-variations" class="toc-h1 toc-link" data-title="Product variations">Product variations</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#product-variation-properties" class="toc-h2 toc-link" data-title="Product variation properties">Product variation properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-product-variation" class="toc-h2 toc-link" data-title="Create a product variation">Create a product variation</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-product-variation" class="toc-h2 toc-link" data-title="Retrieve a product variation">Retrieve a product variation</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-product-variations" class="toc-h2 toc-link" data-title="List all product variations">List all product variations</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-product-variation" class="toc-h2 toc-link" data-title="Update a product variation">Update a product variation</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-product-variation" class="toc-h2 toc-link" data-title="Delete a product variation">Delete a product variation</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-product-variations" class="toc-h2 toc-link" data-title="Batch update product variations">Batch update product variations</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="#product-attribute-term-properties" class="toc-h2 toc-link" data-title="Product attribute term properties">Product 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="#product-shipping-class-properties" class="toc-h2 toc-link" data-title="Product shipping class properties">Product 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>
|
|
<li>
|
|
<a href="#settings" class="toc-h1 toc-link" data-title="Settings">Settings</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#setting-group-properties" class="toc-h2 toc-link" data-title="Setting group properties">Setting group properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-settings-groups" class="toc-h2 toc-link" data-title="List all settings groups">List all settings groups</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#setting-options" class="toc-h1 toc-link" data-title="Setting options">Setting options</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#setting-option-properties" class="toc-h2 toc-link" data-title="Setting option properties">Setting option properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-an-setting-option" class="toc-h2 toc-link" data-title="Retrieve an setting option">Retrieve an setting option</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-setting-options" class="toc-h2 toc-link" data-title="List all setting options">List all setting options</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-setting-option" class="toc-h2 toc-link" data-title="Update a setting option">Update a setting option</a>
|
|
</li>
|
|
<li>
|
|
<a href="#batch-update-setting-options" class="toc-h2 toc-link" data-title="Batch update setting options">Batch update setting options</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#payment-gateways" class="toc-h1 toc-link" data-title="Payment gateways">Payment gateways</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#payment-gateway-properties" class="toc-h2 toc-link" data-title="Payment gateway properties">Payment gateway properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-payment-gateway" class="toc-h2 toc-link" data-title="Retrieve a payment gateway">Retrieve a payment gateway</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-payment-gateways" class="toc-h2 toc-link" data-title="List all payment gateways">List all payment gateways</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-payment-gateway" class="toc-h2 toc-link" data-title="Update a payment gateway">Update a payment gateway</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#shipping-zones" class="toc-h1 toc-link" data-title="Shipping zones">Shipping zones</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#shipping-zone-properties" class="toc-h2 toc-link" data-title="Shipping zone properties">Shipping zone properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#create-a-shipping-zone" class="toc-h2 toc-link" data-title="Create a shipping zone">Create a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-shipping-zone" class="toc-h2 toc-link" data-title="Retrieve a shipping zone">Retrieve a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-shipping-zones" class="toc-h2 toc-link" data-title="List all shipping zones">List all shipping zones</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-shipping-zone" class="toc-h2 toc-link" data-title="Update a shipping zone">Update a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-shipping-zone" class="toc-h2 toc-link" data-title="Delete a shipping zone">Delete a shipping zone</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#shipping-zone-locations" class="toc-h1 toc-link" data-title="Shipping zone locations">Shipping zone locations</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#shipping-location-properties" class="toc-h2 toc-link" data-title="Shipping location properties">Shipping location properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-locations-of-a-shipping-zone" class="toc-h2 toc-link" data-title="List all locations of a shipping zone">List all locations of a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-locations-of-a-shipping-zone" class="toc-h2 toc-link" data-title="Update a locations of a shipping zone">Update a locations of a shipping zone</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#shipping-zone-methods" class="toc-h1 toc-link" data-title="Shipping zone methods">Shipping zone methods</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#shipping-method-properties" class="toc-h2 toc-link" data-title="Shipping method properties">Shipping method properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#include-a-shipping-method-to-a-shipping-zone" class="toc-h2 toc-link" data-title="Include a shipping method to a shipping zone">Include a shipping method to a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-shipping-method-from-a-shipping-zone" class="toc-h2 toc-link" data-title="Retrieve a shipping method from a shipping zone">Retrieve a shipping method from a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-shipping-methods-from-a-shipping-zone" class="toc-h2 toc-link" data-title="List all shipping methods from a shipping zone">List all shipping methods from a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#update-a-shipping-method-of-a-shipping-zone" class="toc-h2 toc-link" data-title="Update a shipping method of a shipping zone">Update a shipping method of a shipping zone</a>
|
|
</li>
|
|
<li>
|
|
<a href="#delete-a-shipping-method-from-a-shipping-zone" class="toc-h2 toc-link" data-title="Delete a shipping method from a shipping zone">Delete a shipping method from a shipping zone</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#shipping-methods" class="toc-h1 toc-link" data-title="Shipping methods">Shipping methods</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#shipping-method-properties" class="toc-h2 toc-link" data-title="Shipping method properties">Shipping method properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-shipping-method" class="toc-h2 toc-link" data-title="Retrieve a shipping method">Retrieve a shipping method</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-shipping-methods" class="toc-h2 toc-link" data-title="List all shipping methods">List all shipping methods</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#system-status" class="toc-h1 toc-link" data-title="System status">System status</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#system-status-properties" class="toc-h2 toc-link" data-title="System status properties">System status properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-system-status-items" class="toc-h2 toc-link" data-title="List all system status items">List all system status items</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#system-status-tools" class="toc-h1 toc-link" data-title="System status tools">System status tools</a>
|
|
<ul class="toc-list-h2">
|
|
<li>
|
|
<a href="#system-status-tool-properties" class="toc-h2 toc-link" data-title="System status tool properties">System status tool properties</a>
|
|
</li>
|
|
<li>
|
|
<a href="#retrieve-a-tool-from-system-status" class="toc-h2 toc-link" data-title="Retrieve a tool from system status">Retrieve a tool from system status</a>
|
|
</li>
|
|
<li>
|
|
<a href="#list-all-tools-from-system-status" class="toc-h2 toc-link" data-title="List all tools from system status">List all tools from system status</a>
|
|
</li>
|
|
<li>
|
|
<a href="#run-a-tool-from-system-status" class="toc-h2 toc-link" data-title="Run a tool from system status">Run a tool from system status</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>v2</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>
|
|
<th>Documentation</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>v2</code></td>
|
|
<td>3.0.x or later</td>
|
|
<td>4.4 or later</td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>v1</code></td>
|
|
<td>2.6.x or later</td>
|
|
<td>4.4 or later</td>
|
|
<td><a href="wp-api-v1.html">v1 docs</a></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/v2?_jsonp=callback</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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?_jsonp=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/v2/products/tags/34"}],"collection":[{"href":"https://example.com/wp-json/wc/v2/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/v2/products?page=2>; rel="next",
|
|
<https://www.example.com/wp-json/wc/v2/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/v2</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/v2'</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/v2"</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">"https://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_api: </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">"wc/v2"</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>
|
|
|
|
<p>If the WordPress user associated with an API key is deleted, the API key will cease to function. API keys are not transferred to other users.</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="s1">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="s1">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="s1">/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="s1">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="s1">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="s1">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="s1">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="s1">+</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="s1">?</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/v2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="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">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="s1">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="s1">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="s1">wc/v2</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/v2'</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/v2"</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/v2"</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/v2/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="s1">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="s1">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="s1">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="s1">wc/v2</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/v2'</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/v2"</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/v2"</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/v2/orders</code>.</p>
|
|
<h4 id='collect-parameters'>Collect parameters</h4>
|
|
<p>Collect and normalize your 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%2Fv2%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/v2</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2
|
|
</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/v2"</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/v2"</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/v2"</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/v2"</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/v2"</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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. Should always be numeric, even if setting a percentage."</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">"string"</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">"percent"</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">"fixed_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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the coupon expires, in the site's timezone."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the coupon expires, as GMT."</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">"string"</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">"If true, the coupon can only be used individually. Other applied coupons will be removed from the cart."</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">"boolean"</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 IDs the coupon can be used on."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"excluded_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 IDs the coupon cannot be used on."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 in total."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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">"If true and if the free shipping method requires a coupon, this coupon will enable free shipping."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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 IDs the coupon applies to."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 IDs the coupon does not apply to."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><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 true, this coupon will not be applied to items that have sale prices."</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">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"string"</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_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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. Should always be numeric, even if setting a percentage."</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">"string"</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">"percent"</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">"fixed_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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the coupon expires, in the site's timezone."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the coupon expires, as GMT."</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">"string"</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">"If true, the coupon can only be used individually. Other applied coupons will be removed from the cart."</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">"boolean"</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 IDs the coupon can be used on."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"excluded_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 IDs the coupon cannot be used on."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 in total."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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">"If true and if the free shipping method requires a coupon, this coupon will enable free shipping."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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 IDs the coupon applies to."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 IDs the coupon does not apply to."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 true, this coupon will not be applied to items that have sale prices."</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">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"string"</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_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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. Should always be numeric, even if setting a percentage."</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">"string"</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">"percent"</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">"fixed_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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the coupon expires, in the site's timezone."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the coupon expires, as GMT."</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">"string"</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">"If true, the coupon can only be used individually. Other applied coupons will be removed from the cart."</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">"boolean"</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 IDs the coupon can be used on."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"excluded_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 IDs the coupon cannot be used on."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 in total."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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">"If true and if the free shipping method requires a coupon, this coupon will enable free shipping."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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 IDs the coupon applies to."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 IDs the coupon does not apply to."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 true, this coupon will not be applied to items that have sale prices."</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">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"string"</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_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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">"Unique identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New user email address."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"New user username."</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">"string"</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">"New user password."</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">"string"</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">"List of billing address data."</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">"object"</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">"List of shipping address data."</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">"object"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"List of billing address data."</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">"object"</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">"List of shipping address data."</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">"object"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="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">"ID to reassign posts to."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"List of billing address data."</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">"object"</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">"List of shipping address data."</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">"object"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"order_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">"The order ID."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"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">"customer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"internal"</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 to customers or internal notes."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"order_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">"The order ID."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Order note content."</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">"string"</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">"If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 order ID."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 order ID."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"order_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">"The order ID."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"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 those of particular parent IDs."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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">"Limit result set to all items except those of a particular parent ID."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"order_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">"The order ID."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"refunded_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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"User ID of user who created the refund."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Product name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"product_id"</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">"Product ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation_id"</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">"Variation ID, if applicable."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"quantity"</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">"Quantity ordered."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of product."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Line subtotal (before discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</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">"Line subtotal tax (before discounts)."</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">"string"</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="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">"readonly"</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">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Tax total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Tax subtotal."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product SKU."</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">"string"</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="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">"readonly"</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">"price"</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">"Product price."</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">"string"</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="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">"readonly"</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">"api_refund"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><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">"When true, the payment gateway API is used to generate the refund."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"order_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">"The order ID."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"order_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">"The order ID."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"integer"</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">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">"Required to be true, as resource does not support trashing."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"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 those of particular parent IDs."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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">"Limit result set to all items except those of a particular parent ID."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"USD"</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">"IRT"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Product name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"product_id"</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">"Product ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation_id"</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">"Variation ID, if applicable."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"quantity"</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">"Quantity ordered."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of product."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Line subtotal (before discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</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">"Line subtotal tax (before discounts)."</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">"string"</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="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">"readonly"</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">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Tax total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Tax subtotal."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product SKU."</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">"string"</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="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">"readonly"</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">"price"</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">"Product price."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"method_title"</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">"Shipping method name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"method_id"</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">"Shipping method ID."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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">"readonly"</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">"total"</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">"Tax total."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Fee name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of fee."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax status of fee."</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">"string"</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="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">"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">"none"</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"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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">"readonly"</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">"total"</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">"Tax total."</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">"string"</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="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">"readonly"</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">"subtotal"</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">"Tax subtotal."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"code"</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">"Coupon code."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"discount_tax"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount total tax."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"IRT"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Product name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"product_id"</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">"Product ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation_id"</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">"Variation ID, if applicable."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"quantity"</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">"Quantity ordered."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of product."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Line subtotal (before discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</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">"Line subtotal tax (before discounts)."</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">"string"</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="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">"readonly"</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">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Tax total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Tax subtotal."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product SKU."</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">"string"</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="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">"readonly"</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">"price"</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">"Product price."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"method_title"</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">"Shipping method name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"method_id"</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">"Shipping method ID."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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">"readonly"</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">"total"</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">"Tax total."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Fee name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of fee."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax status of fee."</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">"string"</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="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">"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">"none"</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"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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">"readonly"</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">"total"</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">"Tax total."</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">"string"</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="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">"readonly"</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">"subtotal"</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">"Tax subtotal."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"code"</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">"Coupon code."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"discount_tax"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount total tax."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"IRT"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Product name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"product_id"</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">"Product ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation_id"</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">"Variation ID, if applicable."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"quantity"</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">"Quantity ordered."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of product."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Line subtotal (before discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</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">"Line subtotal tax (before discounts)."</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">"string"</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="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">"readonly"</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">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Tax total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"subtotal"</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">"Tax subtotal."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product SKU."</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">"string"</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="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">"readonly"</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">"price"</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">"Product price."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"method_title"</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">"Shipping method name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"method_id"</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">"Shipping method ID."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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">"readonly"</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">"total"</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">"Tax total."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"name"</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">"Fee name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax class of fee."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tax status of fee."</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">"string"</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="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">"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">"none"</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"</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">"Line total (after discounts)."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"total_tax"</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">"Line total tax (after discounts)."</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">"string"</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="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">"readonly"</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">"taxes"</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">"Line taxes."</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">"array"</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="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">"readonly"</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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tax rate ID."</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">"integer"</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="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">"readonly"</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">"total"</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">"Tax total."</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">"string"</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="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">"readonly"</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">"subtotal"</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">"Tax subtotal."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Item ID."</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">"integer"</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="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">"readonly"</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">"code"</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">"Coupon code."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"discount"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount total."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"discount_tax"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Discount total tax."</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">"string"</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="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">"readonly"</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">"meta_data"</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">"Meta data."</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">"array"</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="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">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"attribute_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 identifier for the attribute of the terms."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</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="nl">"required"</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"attribute_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 identifier for the attribute of the terms."</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">"integer"</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">"Name for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"attribute_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 identifier for the attribute of the terms."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"attribute_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 identifier for the attribute of the terms."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"attribute_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 identifier for the attribute of the terms."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"attribute_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 identifier for the attribute of the terms."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"Name for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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">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">"Required to be true, as resource does not support trashing."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/products/attributes/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/v2"</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">"Attribute name."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/products/attributes/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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</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="nl">"required"</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"Name for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 data."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 data."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 data."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the variation."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the variation."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"review"</span><span class="p">:</span><span class="w"> </span><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">"Review content."</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">"string"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the review was created, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the review was created, as GMT."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Review rating (0 to 5)."</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">"integer"</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">"Name of the reviewer."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Email of the reviewer."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"review"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 content of the review."</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">"string"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the review was created, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the review was created, as GMT."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Review rating (0 to 5)."</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">"integer"</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">"Reviewer name."</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">"string"</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">"Reviewer email."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/products/(?P<product_id>[\\d]+)/reviews/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/v2"</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"review"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 content of the review."</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">"string"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the review was created, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date the review was created, as GMT."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"rating"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Review rating (0 to 5)."</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">"integer"</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">"Reviewer name."</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">"string"</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">"Reviewer email."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"Name for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"Name for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"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 those of particular parent IDs."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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">"Limit result set to all items except those of a particular parent ID."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 slug."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Limit result set to featured products."</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">"boolean"</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 ID."</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">"string"</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 ID."</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">"string"</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 ID."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 ID (required an assigned attribute)."</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">"string"</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">"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">"Limit result set to products with a specific tax class."</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">"string"</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">"Limit result set to products in stock or out of stock."</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">"boolean"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 on sale."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"min_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">"Limit result set to products based on a minimum price."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"max_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">"Limit result set to products based on a maximum price."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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, as GMT."</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">"date-time"</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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date of sale price, in the site's timezone."</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">"date-time"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"File ID."</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">"string"</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="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">"readonly"</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">"name"</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">"File name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"File URL."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><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">"Number of times downloadable files can be downloaded after purchase."</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">"integer"</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">"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">"Number of days until access to downloadable files expires."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Category ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category name."</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">"string"</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="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">"readonly"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category slug."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tag ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag name."</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">"string"</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="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">"readonly"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag slug."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Image ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"date_created"</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">"The date the image was created, in the site's timezone."</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">"date-time"</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="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">"readonly"</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">"date_created_gmt"</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">"The date the image was created, as GMT."</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">"date-time"</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="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">"readonly"</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">"date_modified"</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">"The date the image was last modified, in the site's timezone."</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">"date-time"</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="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">"readonly"</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">"date_modified_gmt"</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">"The date the image was last modified, as GMT."</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">"date-time"</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="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">"readonly"</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">"src"</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">"Image URL."</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">"string"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"uri"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Image name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"alt"</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">"Image alternative text."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"position"</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">"Image position. 0 means that the image is featured."</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">"integer"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"position"</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">"Attribute position."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"visible"</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">"Define if the attribute is visible on the </span><span class="se">\"</span><span class="s2">Additional information</span><span class="se">\"</span><span class="s2"> tab in the product's page."</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">"boolean"</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">"context"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation"</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">"Define if the attribute can be used as variation."</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">"boolean"</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">"context"</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="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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of available term names of the attribute."</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">"array"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"option"</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">"Selected attribute term name."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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, as GMT."</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">"date-time"</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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date of sale price, in the site's timezone."</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">"date-time"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"File ID."</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">"string"</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="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">"readonly"</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">"name"</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">"File name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"File URL."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 times downloadable files can be downloaded after purchase."</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">"integer"</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 until access to downloadable files expires."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Category ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category name."</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">"string"</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="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">"readonly"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category slug."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tag ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag name."</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">"string"</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="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">"readonly"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag slug."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Image ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"date_created"</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">"The date the image was created, in the site's timezone."</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">"date-time"</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="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">"readonly"</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">"date_created_gmt"</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">"The date the image was created, as GMT."</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">"date-time"</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="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">"readonly"</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">"date_modified"</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">"The date the image was last modified, in the site's timezone."</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">"date-time"</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="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">"readonly"</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">"date_modified_gmt"</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">"The date the image was last modified, as GMT."</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">"date-time"</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="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">"readonly"</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">"src"</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">"Image URL."</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">"string"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"uri"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Image name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"alt"</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">"Image alternative text."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"position"</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">"Image position. 0 means that the image is featured."</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">"integer"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"position"</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">"Attribute position."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"visible"</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">"Define if the attribute is visible on the </span><span class="se">\"</span><span class="s2">Additional information</span><span class="se">\"</span><span class="s2"> tab in the product's page."</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">"boolean"</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">"context"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation"</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">"Define if the attribute can be used as variation."</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">"boolean"</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">"context"</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="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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of available term names of the attribute."</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">"array"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"option"</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">"Selected attribute term name."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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, as GMT."</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">"date-time"</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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date of sale price, in the site's timezone."</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">"date-time"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"File ID."</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">"string"</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="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">"readonly"</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">"name"</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">"File name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"File URL."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 times downloadable files can be downloaded after purchase."</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">"integer"</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 until access to downloadable files expires."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Category ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category name."</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">"string"</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="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">"readonly"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Category slug."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Tag ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag name."</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">"string"</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="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">"readonly"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tag slug."</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">"string"</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="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">"readonly"</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">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Image ID."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"date_created"</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">"The date the image was created, in the site's timezone."</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">"date-time"</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="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">"readonly"</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">"date_created_gmt"</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">"The date the image was created, as GMT."</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">"date-time"</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="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">"readonly"</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">"date_modified"</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">"The date the image was last modified, in the site's timezone."</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">"date-time"</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="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">"readonly"</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">"date_modified_gmt"</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">"The date the image was last modified, as GMT."</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">"date-time"</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="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">"readonly"</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">"src"</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">"Image URL."</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">"string"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"uri"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Image name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"alt"</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">"Image alternative text."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"position"</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">"Image position. 0 means that the image is featured."</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">"integer"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"position"</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">"Attribute position."</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">"integer"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"visible"</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">"Define if the attribute is visible on the </span><span class="se">\"</span><span class="s2">Additional information</span><span class="se">\"</span><span class="s2"> tab in the product's page."</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">"boolean"</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">"context"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"variation"</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">"Define if the attribute can be used as variation."</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">"boolean"</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">"context"</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="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="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"List of available term names of the attribute."</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">"array"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"option"</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">"Selected attribute term name."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/products/(?P<product_id>[\\d]+)/variations"</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/v2"</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">"product_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 identifier for the variable product."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"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 those of particular parent IDs."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"parent_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">"Limit result set to all items except those of a particular parent ID."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 slug."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Limit result set to featured products."</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">"boolean"</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 ID."</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">"string"</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 ID."</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">"string"</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 ID."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 ID (required an assigned attribute)."</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">"string"</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">"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">"Limit result set to products with a specific tax class."</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">"string"</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">"Limit result set to products in stock or out of stock."</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">"boolean"</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 on sale."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"min_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">"Limit result set to products based on a minimum price."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"max_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">"Limit result set to products based on a maximum price."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"product_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 identifier for the variable product."</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">"integer"</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">"Variation description."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation regular price."</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">"string"</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">"Variation sale price."</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">"string"</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, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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, as GMT."</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">"date-time"</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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><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">"Define if the attribute is visible on the </span><span class="se">\"</span><span class="s2">Additional information</span><span class="se">\"</span><span class="s2"> tab in the product's page."</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">"boolean"</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 variation is virtual."</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">"boolean"</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 variation is downloadable."</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">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"File ID."</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">"string"</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="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">"readonly"</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">"name"</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">"File name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"File URL."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><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">"Number of times downloadable files can be downloaded after purchase."</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">"integer"</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">"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">"Number of days until access to downloadable files expires."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 variation level."</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="s2">"boolean"</span><span class="p">,</span><span class="w"> </span><span class="s2">"string"</span><span class="p">]</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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 variation 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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation weight (kg)."</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">"string"</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">"Variation dimensions."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation image data."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"option"</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">"Selected attribute term name."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/products/(?P<product_id>[\\d]+)/variations/(?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/v2"</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the variation."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the variation."</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">"integer"</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">"Variation description."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation regular price."</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">"string"</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">"Variation sale price."</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">"string"</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, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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, as GMT."</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">"date-time"</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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 attribute is visible on the </span><span class="se">\"</span><span class="s2">Additional information</span><span class="se">\"</span><span class="s2"> tab in the product's page."</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">"boolean"</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 variation is virtual."</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">"boolean"</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 variation is downloadable."</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">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"File ID."</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">"string"</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="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">"readonly"</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">"name"</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">"File name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"File URL."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 times downloadable files can be downloaded after purchase."</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">"integer"</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 until access to downloadable files expires."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 variation level."</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="s2">"boolean"</span><span class="p">,</span><span class="w"> </span><span class="s2">"string"</span><span class="p">]</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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 variation 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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation weight (kg)."</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">"string"</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">"Variation dimensions."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation image data."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"option"</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">"Selected attribute term name."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"product_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 identifier for the variable product."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the variation."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/products/(?P<product_id>[\\d]+)/variations/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/v2"</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">"product_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 identifier for the variable product."</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">"integer"</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">"Variation description."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation regular price."</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">"string"</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">"Variation sale price."</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">"string"</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, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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, as GMT."</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">"date-time"</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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 date of sale price, in the site's timezone."</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">"date-time"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"visible"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 attribute is visible on the </span><span class="se">\"</span><span class="s2">Additional information</span><span class="se">\"</span><span class="s2"> tab in the product's page."</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">"boolean"</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 variation is virtual."</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">"boolean"</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 variation is downloadable."</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">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"File ID."</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">"string"</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="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">"readonly"</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">"name"</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">"File name."</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">"string"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"File URL."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 times downloadable files can be downloaded after purchase."</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">"integer"</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 until access to downloadable files expires."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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 variation level."</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="s2">"boolean"</span><span class="p">,</span><span class="w"> </span><span class="s2">"string"</span><span class="p">]</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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 variation 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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation weight (kg)."</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">"string"</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">"Variation dimensions."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">"Variation image data."</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">"object"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Attribute ID."</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">"integer"</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="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="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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Attribute name."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"option"</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">"Selected attribute term name."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Meta data."</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">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"object"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</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">"Meta ID."</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">"integer"</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="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">"readonly"</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">"key"</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">"Meta key."</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">"string"</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="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="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</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">"Meta value."</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">"string"</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="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="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/settings"</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/v2"</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="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/v2/settings"</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/v2/settings/(?P<group_id>[\\w-]+)"</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/v2"</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">"group"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Settings group ID."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/settings/(?P<group_id>[\\w-]+)/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/v2"</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">"group"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Settings group ID."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Setting value."</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">"mixed"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/settings/(?P<group_id>[\\w-]+)/(?P<id>[\\w-]+)"</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/v2"</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="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">"group"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Settings group ID."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"group"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Settings group ID."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Setting value."</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">"mixed"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping/zones"</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/v2"</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="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">"Shipping zone name."</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">"string"</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">"Shipping zone order."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping/zones"</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/v2/shipping/zones/(?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/v2"</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">"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 ID for the resource."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 ID for the resource."</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">"integer"</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 zone name."</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">"string"</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">"Shipping zone order."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 ID for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping/zones/(?P<id>[\\d-]+)/locations"</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/v2"</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="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">"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 ID for the resource."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 ID for the resource."</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">"integer"</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">"Shipping zone location code."</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">"string"</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">"postcode"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"state"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"country"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"continent"</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">"Shipping zone location type."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping/zones/(?P<zone_id>[\\d-]+)/methods"</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/v2"</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">"zone_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 ID for the zone."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"zone_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 ID for the zone."</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">"integer"</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">"Shipping method sort order."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 method enabled status."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"settings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 method settings."</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">"object"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="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">"Shipping method ID."</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping/zones/(?P<zone_id>[\\d-]+)/methods/(?P<instance_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/v2"</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">"zone_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 ID for the zone."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"instance_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 ID for the instance."</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">"integer"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"zone_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 ID for the zone."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"instance_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 ID for the instance."</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">"integer"</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">"Shipping method sort order."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 method enabled status."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"settings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 method settings."</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">"object"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"zone_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 ID for the zone."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"instance_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 ID for the instance."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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">"Unique slug for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"webhook_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 identifier for the webhook."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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">"webhook_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 identifier for the webhook."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"items"</span><span class="p">:</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="s2">"integer"</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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">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">"Webhook secret."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Webhook delivery URL."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2/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/v2"</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"integer"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"boolean"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/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="nl">"/wc/v2/system_status"</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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/system_status"</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/v2/system_status/tools"</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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/system_status/tools"</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/v2/system_status/tools/(?P<id>[\\w-]+)"</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/v2"</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="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">"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 identifier for the resource."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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">"A unique identifier for the tool."</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">"string"</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">"Tool name."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"What running the tool will do."</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">"string"</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">"Tool description."</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">"string"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"success"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Did the tool run successfully?"</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">"boolean"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tool return message."</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">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping_methods"</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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/shipping_methods"</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/v2/shipping_methods/(?P<id>[\\w-]+)"</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/v2"</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">"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 identifier for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/payment_gateways"</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/v2"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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/v2/payment_gateways"</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/v2/payment_gateways/(?P<id>[\\w-]+)"</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/v2"</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="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">"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 identifier for the resource."</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">"string"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</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">"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 identifier for the resource."</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">"string"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 gateway title on checkout."</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">"string"</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">"Payment gateway description on checkout."</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">"string"</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">"Payment gateway sort order."</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">"integer"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 gateway enabled status."</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">"boolean"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"settings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><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 gateway settings."</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">"object"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</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>amount</code></td>
|
|
<td>string</td>
|
|
<td>The amount of discount. Should always be numeric, even if setting a percentage.</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_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the coupon was created, as GMT. <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the coupon was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>discount_type</code></td>
|
|
<td>string</td>
|
|
<td>Determines the type of discount that will be applied. Options: <code>percent</code>, <code>fixed_cart</code> and <code>fixed_product</code>. Default is <code>fixed_cart</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Coupon description.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_expires</code></td>
|
|
<td>string</td>
|
|
<td>The date the coupon expires, in the site's timezone.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_expires_gmt</code></td>
|
|
<td>string</td>
|
|
<td>The date the coupon expires, as GMT.</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>If true, the coupon can only be used individually. Other applied coupons will be removed from the cart. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of product IDs the coupon can be used on.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>excluded_product_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of product IDs 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 in total.</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>If true and if the free shipping method requires a coupon, this coupon will enable free shipping. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_categories</code></td>
|
|
<td>array</td>
|
|
<td>List of category IDs the coupon applies to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>excluded_product_categories</code></td>
|
|
<td>array</td>
|
|
<td>List of category IDs the coupon does not apply to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exclude_sale_items</code></td>
|
|
<td>boolean</td>
|
|
<td>If true, this coupon will not be applied to items that have sale prices. Default is <code>false</code>.</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 (or guest email addresses) that have used the coupon. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#coupon-meta-data-properties">Coupon - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='coupon-meta-data-properties'>Coupon - Meta data 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>Meta ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta value.</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/v2/coupons</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/coupons <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"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="dl">"</span><span class="s2">10</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">individual_use</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">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="nx">post</span><span class="p">(</span><span class="dl">"</span><span class="s2">coupons</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">'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="s1">'10'</span><span class="p">,</span>
|
|
<span class="s1">'individual_use'</span> <span class="o">=></span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="s1">'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="s">"10"</span><span class="p">,</span>
|
|
<span class="s">"individual_use"</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span>
|
|
<span class="s">"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="s2">"10"</span><span class="p">,</span>
|
|
<span class="ss">individual_use: </span><span class="kp">true</span><span class="p">,</span>
|
|
<span class="ss">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">719</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23: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">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23:00"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/719"</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/v2/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/v2/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/coupons/719 <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/719</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/719'</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/719"</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/719"</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">719</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23: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">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23:00"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/719"</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/v2/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/v2/coupons</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/coupons <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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">720</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:25:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:25:02"</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">"2017-03-21T15:25:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:25:02"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">true</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">"meta_data"</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/v2/coupons/720"</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/v2/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">719</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23: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">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23:00"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/719"</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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>. Default is <code>date</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/v2/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v2/coupons/719 <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="dl">"</span><span class="s2">5</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">coupons/719</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">'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/719'</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">"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/719"</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">"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/719"</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">719</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23: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">"2017-03-21T15:26:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:26:16"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/719"</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/v2/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/v2/coupons/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/coupons/719?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/719</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/719'</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/719"</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/719"</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">719</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23: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">"2017-03-21T15:26:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:26:16"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/719"</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/v2/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/v2/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/v2/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": 719,
|
|
"minimum_amount": "50.00"
|
|
}
|
|
],
|
|
"delete": [
|
|
720
|
|
]
|
|
}'</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="dl">"</span><span class="s2">20</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">individual_use</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">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="dl">"</span><span class="s2">30</span><span class="dl">"</span><span class="p">,</span>
|
|
<span class="na">individual_use</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="na">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">719</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">720</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="s1">'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="s1">'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">719</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">720</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="s">"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="s">"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">719</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">720</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="s2">"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="s2">"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">719</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">720</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">721</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:27:29"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:27:29"</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">"2017-03-21T15:27:29"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:27:29"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/721"</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/v2/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">722</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:27:31"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:27: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">"2017-03-21T15:27:31"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:27:31"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/722"</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/v2/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">719</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:23:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:23: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">"2017-03-21T15:27:32"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:27:32"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">"meta_data"</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/v2/coupons/719"</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/v2/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">720</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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T15:25:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:25:02"</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">"2017-03-21T15:25:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T18:25:02"</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">"date_expires"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_expires_gmt"</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">"excluded_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="kc">null</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">true</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">"meta_data"</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/v2/coupons/720"</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/v2/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_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was created, as GMT. <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the customer was last modified, as GMT. <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>role</code></td>
|
|
<td>string</td>
|
|
<td>Customer role. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>username</code></td>
|
|
<td>string</td>
|
|
<td>Customer login name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>password</code></td>
|
|
<td>string</td>
|
|
<td>Customer password. <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>billing</code></td>
|
|
<td>object</td>
|
|
<td>List of billing address data. See <a href="#customer-billing-properties">Customer - Billing properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping</code></td>
|
|
<td>object</td>
|
|
<td>List of shipping address data. See <a href="#customer-shipping-properties">Customer - Shipping properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>is_paying_customer</code></td>
|
|
<td>bool</td>
|
|
<td>Is the customer a paying customer? <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. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#customer-meta-data-properties">Customer - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='customer-billing-properties'>Customer - Billing 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='customer-shipping-properties'>Customer - Shipping 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>
|
|
<h3 id='customer-meta-data-properties'>Customer - Meta data 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>Meta ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta value.</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/v2/customers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/customers <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"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">25</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">"2017-03-21T16:09:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09: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">"2017-03-21T16:09:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09:30"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/8eb1b522f60d11fa897de1dc6351b7e8?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/25"</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/v2/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/v2/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/customers/25 <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/25</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/25'</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/25"</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/25"</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">25</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">"2017-03-21T16:09:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09: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">"2017-03-21T16:09:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09:30"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/8eb1b522f60d11fa897de1dc6351b7e8?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/25"</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/v2/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/v2/customers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/customers <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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">26</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">"2017-03-21T16:11:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:11:14"</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">"2017-03-21T16:11:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:11:16"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/be7b5febff88a2d947c3289e90cdf017?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/26"</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/v2/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">25</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">"2017-03-21T16:09:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09: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">"2017-03-21T16:09:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09:30"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/8eb1b522f60d11fa897de1dc6351b7e8?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/25"</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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>asc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>id</code>, <code>include</code>, <code>name</code> and <code>registered_date</code>. Default is <code>name</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. Options: <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>. Default is <code>customer</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/v2/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v2/customers/25 <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/25</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/25'</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/25"</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/25"</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">25</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">"2017-03-21T16:09:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09: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">"2017-03-21T16:12:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:12:28"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/8eb1b522f60d11fa897de1dc6351b7e8?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/25"</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/v2/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/v2/customers/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/customers/25?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/25</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/25'</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/25"</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/25"</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">25</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">"2017-03-21T16:09:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09: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">"2017-03-21T16:12:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:12:28"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/8eb1b522f60d11fa897de1dc6351b7e8?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/25"</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/v2/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>
|
|
<tr>
|
|
<td><code>reassign</code></td>
|
|
<td>integer</td>
|
|
<td>User ID to reassign posts to.</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/v2/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/v2/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": 26,
|
|
"billing": {
|
|
"phone": "(11) 1111-1111"
|
|
}
|
|
}
|
|
],
|
|
"delete": [
|
|
25
|
|
]
|
|
}'</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">26</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">11</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">26</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">25</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">26</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">25</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">26</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">25</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">27</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">"2017-03-21T16:13:58"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:13: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">"2017-03-21T16:13:59"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:13:59"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/6ad0b094bac53a85bb282ccdb3958279?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/27"</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/v2/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">28</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">"2017-03-21T16:14:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:14: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">"2017-03-21T16:14:01"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:14:01"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/ea9ad095f2970f27cbff07e7f5e99453?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/28"</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/v2/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">26</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">"2017-03-21T16:11:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:11:14"</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">"2017-03-21T16:14:03"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:14:03"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/be7b5febff88a2d947c3289e90cdf017?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/26"</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/v2/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">25</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">"2017-03-21T16:09:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:09: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">"2017-03-21T16:12:28"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:12:28"</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">"role"</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">"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">"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">"is_paying_customer"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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/8eb1b522f60d11fa897de1dc6351b7e8?s=96"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</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/v2/customers/25"</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/v2/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/v2/customers/<id>/downloads</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/customers/26/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/26/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/26/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/26/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/26/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_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"91447fd1849316bbc89dfb7e986a6006"</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=87&order=wc_order_58d17c18352&email=joao.silva%40example.com&key=91447fd1849316bbc89dfb7e986a6006"</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">87</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"product_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #2"</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 #2 &ndash; Song 2"</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">723</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_58d17c18352"</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">"3"</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">"access_expires_gmt"</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">"Song 2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"file"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com/wp-content/uploads/woocommerce_uploads/2013/06/Song.mp3"</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/v2/customers/26/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/v2/products/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">"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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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_id</code></td>
|
|
<td>string</td>
|
|
<td>Download ID (MD5). <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<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>product_id</code></td>
|
|
<td>integer</td>
|
|
<td>Downloadable product ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product_name</code></td>
|
|
<td>string</td>
|
|
<td>Product name. <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>Number 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 download access expires, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>access_expires_gmt</code></td>
|
|
<td>string</td>
|
|
<td>The date when download access expires, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file</code></td>
|
|
<td>object</td>
|
|
<td>File details. <i class="label label-info">read-only</i> See <a href="#customers-downloads-file-properties">Customers downloads - File properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='customer-downloads-file-properties'>Customer downloads - File properties</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>File name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file</code></td>
|
|
<td>string</td>
|
|
<td>File URL. <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>number</code></td>
|
|
<td>string</td>
|
|
<td>Order number. <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>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>version</code></td>
|
|
<td>string</td>
|
|
<td>Version of WooCommerce which last updated the order. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Order status. Options: <code>pending</code>, <code>processing</code>, <code>on-hold</code>, <code>completed</code>, <code>cancelled</code>, <code>refunded</code>, <code>failed</code> and <code>trash</code>. Default is <code>pending</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency</code></td>
|
|
<td>string</td>
|
|
<td>Currency the order was created with, in ISO format. Options: <code>AED</code>, <code>AFN</code>, <code>ALL</code>, <code>AMD</code>, <code>ANG</code>, <code>AOA</code>, <code>ARS</code>, <code>AUD</code>, <code>AWG</code>, <code>AZN</code>, <code>BAM</code>, <code>BBD</code>, <code>BDT</code>, <code>BGN</code>, <code>BHD</code>, <code>BIF</code>, <code>BMD</code>, <code>BND</code>, <code>BOB</code>, <code>BRL</code>, <code>BSD</code>, <code>BTC</code>, <code>BTN</code>, <code>BWP</code>, <code>BYR</code>, <code>BZD</code>, <code>CAD</code>, <code>CDF</code>, <code>CHF</code>, <code>CLP</code>, <code>CNY</code>, <code>COP</code>, <code>CRC</code>, <code>CUC</code>, <code>CUP</code>, <code>CVE</code>, <code>CZK</code>, <code>DJF</code>, <code>DKK</code>, <code>DOP</code>, <code>DZD</code>, <code>EGP</code>, <code>ERN</code>, <code>ETB</code>, <code>EUR</code>, <code>FJD</code>, <code>FKP</code>, <code>GBP</code>, <code>GEL</code>, <code>GGP</code>, <code>GHS</code>, <code>GIP</code>, <code>GMD</code>, <code>GNF</code>, <code>GTQ</code>, <code>GYD</code>, <code>HKD</code>, <code>HNL</code>, <code>HRK</code>, <code>HTG</code>, <code>HUF</code>, <code>IDR</code>, <code>ILS</code>, <code>IMP</code>, <code>INR</code>, <code>IQD</code>, <code>IRR</code>, <code>IRT</code>, <code>ISK</code>, <code>JEP</code>, <code>JMD</code>, <code>JOD</code>, <code>JPY</code>, <code>KES</code>, <code>KGS</code>, <code>KHR</code>, <code>KMF</code>, <code>KPW</code>, <code>KRW</code>, <code>KWD</code>, <code>KYD</code>, <code>KZT</code>, <code>LAK</code>, <code>LBP</code>, <code>LKR</code>, <code>LRD</code>, <code>LSL</code>, <code>LYD</code>, <code>MAD</code>, <code>MDL</code>, <code>MGA</code>, <code>MKD</code>, <code>MMK</code>, <code>MNT</code>, <code>MOP</code>, <code>MRO</code>, <code>MUR</code>, <code>MVR</code>, <code>MWK</code>, <code>MXN</code>, <code>MYR</code>, <code>MZN</code>, <code>NAD</code>, <code>NGN</code>, <code>NIO</code>, <code>NOK</code>, <code>NPR</code>, <code>NZD</code>, <code>OMR</code>, <code>PAB</code>, <code>PEN</code>, <code>PGK</code>, <code>PHP</code>, <code>PKR</code>, <code>PLN</code>, <code>PRB</code>, <code>PYG</code>, <code>QAR</code>, <code>RON</code>, <code>RSD</code>, <code>RUB</code>, <code>RWF</code>, <code>SAR</code>, <code>SBD</code>, <code>SCR</code>, <code>SDG</code>, <code>SEK</code>, <code>SGD</code>, <code>SHP</code>, <code>SLL</code>, <code>SOS</code>, <code>SRD</code>, <code>SSP</code>, <code>STD</code>, <code>SYP</code>, <code>SZL</code>, <code>THB</code>, <code>TJS</code>, <code>TMT</code>, <code>TND</code>, <code>TOP</code>, <code>TRY</code>, <code>TTD</code>, <code>TWD</code>, <code>TZS</code>, <code>UAH</code>, <code>UGX</code>, <code>USD</code>, <code>UYU</code>, <code>UZS</code>, <code>VEF</code>, <code>VND</code>, <code>VUV</code>, <code>WST</code>, <code>XAF</code>, <code>XCD</code>, <code>XOF</code>, <code>XPF</code>, <code>YER</code>, <code>ZAR</code> and <code>ZMW</code>. Default is <code>USD</code>.</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_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was created, as GMT. <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was last modified, as GMT. <i class="label label-info">read-only</i></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>prices_include_tax</code></td>
|
|
<td>boolean</td>
|
|
<td>True the prices included tax during checkout. <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. 0 for guests. Default is <code>0</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>customer_note</code></td>
|
|
<td>string</td>
|
|
<td>Note left by customer during checkout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>billing</code></td>
|
|
<td>object</td>
|
|
<td>Billing address. See <a href="#order-billing-properties">Order - Billing properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping</code></td>
|
|
<td>object</td>
|
|
<td>Shipping address. See <a href="#order-shipping-properties">Order - Shipping 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>transaction_id</code></td>
|
|
<td>string</td>
|
|
<td>Unique transaction ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_paid</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was paid, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_paid_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was paid, as GMT. <i class="label label-info">read-only</i></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_completed_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order was completed, as GMT. <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>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>line_items</code></td>
|
|
<td>array</td>
|
|
<td>Line items data. See <a href="#order-line-items-properties">Order - Line items properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_lines</code></td>
|
|
<td>array</td>
|
|
<td>Tax lines data. See <a href="#order-tax-lines-properties">Order - 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="#order-shipping-lines-properties">Order - Shipping lines properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fee_lines</code></td>
|
|
<td>array</td>
|
|
<td>Fee lines data. See <a href="#order-fee-lines-properties">Order - Fee lines properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>coupon_lines</code></td>
|
|
<td>array</td>
|
|
<td>Coupons line data. See <a href="#order-coupon-lines-properties">Order - Coupon lines properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>refunds</code></td>
|
|
<td>array</td>
|
|
<td>List of refunds. See <a href="#order-refunds-properties">Order - Refunds properties</a> <i class="label label-info">read-only</i></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>
|
|
</tbody></table>
|
|
<h3 id='order-billing-properties'>Order - Billing 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>Country code in ISO 3166-1 alpha-2 format.</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='order-shipping-properties'>Order - Shipping 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>Country code in ISO 3166-1 alpha-2 format.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-meta-data-properties'>Order - Meta data 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>Meta ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta value.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-line-items-properties'>Order - Line items properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Item ID. <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>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>integer</td>
|
|
<td>Tax class of product.</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). <i class="label label-info">read-only</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. See <a href="#order-taxes-properties">Order - Taxes properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></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>price</code></td>
|
|
<td>string</td>
|
|
<td>Product price. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-tax-lines-properties'>Order - Tax lines properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>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. <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>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-shipping-lines-properties'>Order - Shipping lines properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>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.</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. See <a href="#order-taxes-properties">Order - Taxes properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-fee-lines-properties'>Order - Fee lines properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Item ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Fee name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class of fee.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status of fee. Options: <code>taxable</code> and <code>none</code>.</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. See <a href="#order-taxes-properties">Order - Taxes properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-coupon-lines-properties'>Order - Coupon lines properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Item ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>code</code></td>
|
|
<td>string</td>
|
|
<td>Coupon code.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>discount</code></td>
|
|
<td>string</td>
|
|
<td>Discount total.</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>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-refunds-properties'>Order - Refunds properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>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>
|
|
<h3 id='order-taxes-properties'>Order - Taxes 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. <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>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-meta-data-properties">Order - Meta data properties</a></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/v2/orders</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of create a paid order:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"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="s1">'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">727</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"727"</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_58d2d042d1d"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:02"</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">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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.35"</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">"29.35"</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.35"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</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">"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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13106</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">315</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">316</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2095</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2096</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">318</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="mi">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.35"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">317</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/727"</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/v2/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/v2/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/orders/727 <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/727</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/727'</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/727"</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/727"</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">727</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"727"</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_58d2d042d1d"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:02"</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">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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.35"</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">"29.35"</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.35"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</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">"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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13106</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">315</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">316</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2095</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2096</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">318</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="mi">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.35"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">317</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/727"</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/v2/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/v2/orders</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/orders <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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">727</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"727"</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_58d2d042d1d"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:02"</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">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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.35"</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">"29.35"</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.35"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</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">"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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13106</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13109</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">"_order_stock_reduced"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">315</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">316</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2095</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2096</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">318</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="mi">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.35"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">317</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/727"</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/v2/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">723</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"723"</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_58d17c18352"</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">"checkout"</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">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T16:16:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:16: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">"2017-03-21T16:54:51"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:54:51"</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">"39.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">"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">"customer_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">"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">"mozilla/5.0 (x11; ubuntu; linux x86_64; rv:52.0) gecko/20100101 firefox/52.0"</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">"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">"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">"date_paid"</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_paid_gmt"</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_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T16:54:51"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:54:51"</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">"5040ce7273261e31d8bcf79f9be3d279"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13023</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">311</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #2"</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">87</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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_data"</span><span class="p">:</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="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="mi">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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">313</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo 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">34</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</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="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="mi">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">"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">312</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:25"</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2057</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">"Items"</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">"Woo Album #2 &times; 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="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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">726</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"refund"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-10.00"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">724</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"refund"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-9.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">"_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/v2/orders/723"</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/v2/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/v2/customers/26"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>. Default is <code>date</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to those of particular parent IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_exclude</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to all items except those of a particular parent ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to orders assigned a specific status. Options: <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>. Default is <code>any</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to orders assigned a specific customer.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>product</code></td>
|
|
<td>integer</td>
|
|
<td>Limit result set to orders assigned a specific product.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dp</code></td>
|
|
<td>integer</td>
|
|
<td>Number of decimal points to use in each resource. Default is <code>2</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-an-order'>Update an Order</h2>
|
|
<p>This API lets you make changes to an order.</p>
|
|
<h3 id='http-request-4'>HTTP Request</h3>
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v2/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v2/orders/727 <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/727</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/727'</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/727"</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/727"</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">727</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"727"</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_58d2d042d1d"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:02"</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">"2017-03-22T16:30:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:30:35"</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.35"</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">"29.35"</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.35"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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">"2017-03-22T16:30:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:30:35"</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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13106</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13109</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">"_order_stock_reduced"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">315</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">316</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2095</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2096</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">318</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="mi">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.35"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">317</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/727"</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/v2/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/v2/orders/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/orders/727?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/727</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/727'</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/727"</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/727"</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">727</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"727"</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_58d2d042d1d"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:02"</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">"2017-03-22T16:30:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:30:35"</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.35"</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">"29.35"</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.35"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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">"2017-03-22T16:30:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:30:35"</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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13106</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13109</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">"_order_stock_reduced"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">315</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">316</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2095</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2096</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">318</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="mi">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.35"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">317</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/727"</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/v2/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/v2/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/v2/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": 727,
|
|
"shipping_methods": "Local Delivery"
|
|
}
|
|
],
|
|
"delete": [
|
|
723
|
|
]
|
|
}'</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">727</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">723</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">727</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">723</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">727</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">723</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">727</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">723</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">728</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"728"</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_58d2d18e580"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:33:34"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:33: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">"2017-03-22T16:33:34"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:33:34"</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.25"</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">"62.25"</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.25"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</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_paid_gmt"</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_completed"</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_completed_gmt"</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">"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">"meta_data"</span><span class="p">:</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">319</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="mi">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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">320</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">321</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2133</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2134</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">323</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="mi">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.25"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">322</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/728"</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/v2/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">729</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"729"</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_58d2d196171"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:33:42"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:33:42"</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">"2017-03-22T16:33:47"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:33:47"</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">"2.40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"54.40"</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.40"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:33:47"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:33:47"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</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">"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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13198</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">324</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2153</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2154</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">325</span><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 &ndash; Color: Green, Size: S Test"</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">"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="s2">"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="s2">"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_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2164</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2165</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">"size"</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">"S Test"</span><span class="w">
|
|
</span><span class="p">}</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="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="mi">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">"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">327</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="mi">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.40"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">326</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/729"</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/v2/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">727</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"727"</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_58d2d042d1d"</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">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:02"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:02"</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">"2017-03-22T16:30:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:30:35"</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.35"</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">"29.35"</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.35"</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">"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">"customer_ip_address"</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_user_agent"</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">"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">"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">"date_paid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T16:28:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_paid_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:28:08"</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">"2017-03-22T16:30:35"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T19:30:35"</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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13106</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13109</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">"_order_stock_reduced"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">315</span><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">"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">"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="s2">"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="s2">"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_data"</span><span class="p">:</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="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="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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">316</span><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 &ndash; Color: Black, Size: M Test"</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12.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.90"</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">"12.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.90"</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="s2">"0.9"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2095</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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2096</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">"size"</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">"M Test"</span><span class="w">
|
|
</span><span class="p">}</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="s2">"Bar3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="mi">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">"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">318</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="mi">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.35"</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="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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">317</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</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/v2/orders/727"</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/v2/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">723</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">"number"</span><span class="p">:</span><span class="w"> </span><span class="s2">"723"</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_58d17c18352"</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">"checkout"</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">"3.0.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">"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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T16:16:00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:16: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">"2017-03-21T16:54:51"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:54:51"</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">"39.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">"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">"customer_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">"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">"mozilla/5.0 (x11; ubuntu; linux x86_64; rv:52.0) gecko/20100101 firefox/52.0"</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">"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">"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">"date_paid"</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_paid_gmt"</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_completed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T16:54:51"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_completed_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:54:51"</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">"5040ce7273261e31d8bcf79f9be3d279"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13023</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">"_download_permissions_granted"</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">"yes"</span><span class="w">
|
|
</span><span class="p">}</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">311</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #2"</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">87</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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_data"</span><span class="p">:</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="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="mi">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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">313</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo 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">34</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"20.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"meta_data"</span><span class="p">:</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="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="mi">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">"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">312</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:25"</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="nl">"meta_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2057</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">"Items"</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">"Woo Album #2 &times; 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="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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">726</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"refund"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-10.00"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">724</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"refund"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-9.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">"_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/v2/orders/723"</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/v2/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/v2/customers/26"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order note was created, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>note</code></td>
|
|
<td>string</td>
|
|
<td>Order note content. <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>customer_note</code></td>
|
|
<td>boolean</td>
|
|
<td>If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only. 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/v2/orders/<id>/notes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/orders/723/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/723/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/723/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/723/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/723/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">281</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">"2017-03-21T16:46:41"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:46:41"</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/v2/orders/723/notes/281"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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/v2/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/v2/orders/723/notes/281 <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/723/notes/281</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/723/notes/281'</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/723/notes/281"</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/723/notes/281"</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">281</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">"2017-03-21T16:46:41"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:46:41"</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/v2/orders/723/notes/281"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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/v2/orders/<id>/notes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/orders/723/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/723/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/723/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/723/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/723/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">281</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">"2017-03-21T16:46:41"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:46:41"</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/v2/orders/723/notes/281"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">280</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">"2017-03-21T16:16:58"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:16:58"</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 On hold to Completed."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"customer_note"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="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/v2/orders/723/notes/280"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">279</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">"2017-03-21T16:16:46"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:16:46"</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">"Awaiting BACS payment Order status changed from Pending payment to On hold."</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/v2/orders/723/notes/279"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Limit result to customers or internal notes. Options: <code>any</code>, <code>customer</code> and <code>internal</code>. Default is <code>any</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<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/v2/orders/<id>/notes/<note_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/orders/723/notes/281?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/723/notes/281</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/723/notes/281'</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/723/notes/281"</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/723/notes/281"</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">281</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">"2017-03-21T16:46:41"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:46:41"</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/v2/orders/723/notes/281"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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>
|
|
<h1 id='refunds'>Refunds</h1>
|
|
<p>The refunds API allows you to create, view, and delete individual refunds.</p>
|
|
<h2 id='order-refund-properties'>Order 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>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the order refund was created, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>amount</code></td>
|
|
<td>string</td>
|
|
<td>Refund amount.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reason</code></td>
|
|
<td>string</td>
|
|
<td>Reason for refund.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>refunded_by</code></td>
|
|
<td>integer</td>
|
|
<td>User ID of user who created the refund.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-refund-meta-data-properties">Order refund - Meta data properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>line_items</code></td>
|
|
<td>array</td>
|
|
<td>Line items data. See <a href="#order-refund-line-items-properties">Order refund - Line items properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>api_refund</code></td>
|
|
<td>boolean</td>
|
|
<td>When true, the payment gateway API is used to generate the refund. Default is <code>true</code>. <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-refund-meta-data-properties'>Order refund - Meta data 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>Meta ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta value.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='order-refund-line-items-properties'>Order refund - Line items properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Item ID. <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>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>integer</td>
|
|
<td>Tax class of product.</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). <i class="label label-info">read-only</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. See <a href="#order-refund-line-item-taxes-properties">Order refund line item - Taxes properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#order-refund-meta-data-properties">Order refund - Meta data properties</a></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>price</code></td>
|
|
<td>string</td>
|
|
<td>Product price. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h4 id='order-refund-line-item-taxes-properties'>Order refund line item - Taxes properties</h4>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Tax rate ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>total</code></td>
|
|
<td>string</td>
|
|
<td>Tax total. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subtotal</code></td>
|
|
<td>string</td>
|
|
<td>Tax subtotal. <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/v2/orders/<id>/refunds</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/orders/723/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/723/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/723/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/723/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/723/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">726</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">"2017-03-21T17:07:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T20:07:11"</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">"meta_data"</span><span class="p">:</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">"_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/v2/orders/723/refunds/726"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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/v2/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/v2/orders/723/refunds/726 <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/723/refunds/726</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/723/refunds/726'</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/723/refunds/726"</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/723/refunds/726"</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">726</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">"2017-03-21T17:07:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T20:07:11"</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">"meta_data"</span><span class="p">:</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">"_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/v2/orders/723/refunds/726"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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/v2/orders/<id>/refunds</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/orders/723/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/723/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/723/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/723/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/723/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">726</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">"2017-03-21T17:07:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T20:07:11"</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">"refunded_by"</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">"meta_data"</span><span class="p">:</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">"_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/v2/orders/723/refunds/726"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">724</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">"2017-03-21T16:55:37"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T19:55:37"</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">"9.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">"refunded_by"</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">"meta_data"</span><span class="p">:</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">314</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Woo Album #2"</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">87</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">"subtotal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"subtotal_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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">"-9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"total_tax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.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_data"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2076</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">"_refunded_item_id"</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">"311"</span><span class="w">
|
|
</span><span class="p">}</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="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="mi">-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">"_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/v2/orders/723/refunds/724"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>. Default is <code>date</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to those of particular parent IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_exclude</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to all items except those of a particular parent ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dp</code></td>
|
|
<td>integer</td>
|
|
<td>Number of decimal points to use in each resource. Default is <code>2</code>.</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/v2/orders/<id>/refunds/<refund_id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/orders/723/refunds/726?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/723/refunds/726</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/723/refunds/726'</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/723/refunds/726"</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/723/refunds/726"</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">726</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">"2017-03-21T17:07:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-21T20:07:11"</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">"meta_data"</span><span class="p">:</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">"_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/v2/orders/723/refunds/726"</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/v2/orders/723/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/v2/orders/723"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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>
|
|
<th></th>
|
|
<th></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Product name.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>slug</code></td>
|
|
<td>string</td>
|
|
<td>Product slug.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>permalink</code></td>
|
|
<td>string</td>
|
|
<td>Product URL. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the product was created, as GMT. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the product was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Product type. Options: <code>simple</code>, <code>grouped</code>, <code>external</code> and <code>variable</code>. Default is <code>simple</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Product status (post status). Options: <code>draft</code>, <code>pending</code>, <code>private</code> and <code>publish</code>. Default is <code>publish</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>featured</code></td>
|
|
<td>boolean</td>
|
|
<td>Featured product. Default is <code>false</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>catalog_visibility</code></td>
|
|
<td>string</td>
|
|
<td>Catalog visibility. Options: <code>visible</code>, <code>catalog</code>, <code>search</code> and <code>hidden</code>. Default is <code>visible</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Product description.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>short_description</code></td>
|
|
<td>string</td>
|
|
<td>Product short description.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Unique identifier.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price</code></td>
|
|
<td>string</td>
|
|
<td>Current product price. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>regular_price</code></td>
|
|
<td>string</td>
|
|
<td>Product regular price.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sale_price</code></td>
|
|
<td>string</td>
|
|
<td>Product sale price.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_from</code></td>
|
|
<td>date-time</td>
|
|
<td>Start date of sale price, in the site's timezone.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_from_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>Start date of sale price, as GMT.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_to</code></td>
|
|
<td>date-time</td>
|
|
<td>End date of sale price, in the site's timezone.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_to_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>End date of sale price, as GMT.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>price_html</code></td>
|
|
<td>string</td>
|
|
<td>Price formatted in HTML. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>virtual</code></td>
|
|
<td>boolean</td>
|
|
<td>If the product is virtual. Default is <code>false</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloadable</code></td>
|
|
<td>boolean</td>
|
|
<td>If the product is downloadable. Default is <code>false</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads</code></td>
|
|
<td>array</td>
|
|
<td>List of downloadable files. See <a href="#product-downloads-properties">Product - Downloads properties</a></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_limit</code></td>
|
|
<td>integer</td>
|
|
<td>Number of times downloadable files can be downloaded after purchase. Default is <code>-1</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_expiry</code></td>
|
|
<td>integer</td>
|
|
<td>Number of days until access to downloadable files expires. Default is <code>-1</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>external_url</code></td>
|
|
<td>string</td>
|
|
<td>Product external URL. Only for external products.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>button_text</code></td>
|
|
<td>string</td>
|
|
<td>Product external button text. Only for external products.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status. Options: <code>taxable</code>, <code>shipping</code> and <code>none</code>. Default is <code>taxable</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Tax class.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>manage_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Stock management at product level. Default is <code>false</code>.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>stock_quantity</code></td>
|
|
<td>integer</td>
|
|
<td>Stock quantity.</td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backorders</code></td>
|
|
<td>string</td>
|
|
<td>If managing stock, this controls if backorders are allowed. Options: <code>no</code>, <code>notify</code> and <code>yes</code>. Default is <code>no</code>.</td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>backordered</code></td>
|
|
<td>boolean</td>
|
|
<td>Shows if the product is on backordered. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>weight</code></td>
|
|
<td>string</td>
|
|
<td>Product weight.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dimensions</code></td>
|
|
<td>object</td>
|
|
<td>Product dimensions. See <a href="#product-dimensions-properties">Product - Dimensions properties</a></td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Shipping class slug.</td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>reviews_allowed</code></td>
|
|
<td>boolean</td>
|
|
<td>Allow reviews. Default is <code>true</code>.</td>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></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>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>related_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of related products IDs. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>upsell_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of up-sell products IDs.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>cross_sell_ids</code></td>
|
|
<td>array</td>
|
|
<td>List of cross-sell products IDs.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_id</code></td>
|
|
<td>integer</td>
|
|
<td>Product parent ID.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>purchase_note</code></td>
|
|
<td>string</td>
|
|
<td>Optional note to send the customer after purchase.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>categories</code></td>
|
|
<td>array</td>
|
|
<td>List of categories. See <a href="#product-categories-properties">Product - Categories properties</a></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tags</code></td>
|
|
<td>array</td>
|
|
<td>List of tags. See <a href="#product-tags-properties">Product - Tags properties</a></td>
|
|
<td>array</td>
|
|
<td>List of images. See <a href="#product-images-properties">Product - Images properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attributes</code></td>
|
|
<td>array</td>
|
|
<td>List of attributes. See <a href="#product-attributes-properties">Product - Attributes properties</a></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default_attributes</code></td>
|
|
<td>array</td>
|
|
<td>Defaults variation attributes. See <a href="#product-default-attributes-properties">Product - Default attributes properties</a></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>variations</code></td>
|
|
<td>array</td>
|
|
<td>List of variations IDs. <i class="label label-info">read-only</i></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>grouped_products</code></td>
|
|
<td>array</td>
|
|
<td>List of grouped products ID.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>menu_order</code></td>
|
|
<td>integer</td>
|
|
<td>Menu order, used to custom sort products.</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#product-meta-data-properties">Product - Meta data properties</a></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-downloads-properties'>Product - Downloads properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>string</td>
|
|
<td>File ID.</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.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-dimensions-properties'>Product - Dimensions properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>length</code></td>
|
|
<td>string</td>
|
|
<td>Product length.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>width</code></td>
|
|
<td>string</td>
|
|
<td>Product width.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>height</code></td>
|
|
<td>string</td>
|
|
<td>Product height.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-categories-properties'>Product - Categories 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='product-tags-properties'>Product - Tags 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='product-images-properties'>Product - Images properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>integer</td>
|
|
<td>Image ID.</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_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was created, as GMT. <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>src</code></td>
|
|
<td>string</td>
|
|
<td>Image URL.</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. 0 means that the image is featured.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-attributes-properties'>Product - Attributes 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name.</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='product-default-attributes-properties'>Product - Default attributes 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>option</code></td>
|
|
<td>string</td>
|
|
<td>Selected attribute term name.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-meta-data-properties'>Product - Meta data 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>Meta ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta value.</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/v2/products</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>Example of how to create a <code>simple</code> product:</p>
|
|
</blockquote>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/products <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"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">794</span><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-19"</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-19/"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">53</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">40</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">56</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">479</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">99</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">792</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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/2017/03/T_2_front-4.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">793</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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/2017/03/T_2_back-2.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">"meta_data"</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/v2/products/794"</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/v2/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/v2/products <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"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"
|
|
}
|
|
]
|
|
}'</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="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="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="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="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">799</span><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-22"</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-22/"</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">"2017-03-23T17:03:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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">"2017-03-23T17:03:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:12"</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">""</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><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">false</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">"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">472</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">387</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">19</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">53</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">396</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">795</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">"2017-03-23T14:03:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:08"</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">"2017-03-23T14:03:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:08"</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/2017/03/T_4_front-11.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">796</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">"2017-03-23T14:03:09"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:09"</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">"2017-03-23T14:03:09"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:09"</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/2017/03/T_4_back-10.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">797</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">"2017-03-23T14:03:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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">"2017-03-23T14:03:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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/2017/03/T_3_front-10.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">798</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">"2017-03-23T14:03:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:11"</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">"2017-03-23T14:03:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:11"</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/2017/03/T_3_back-10.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">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">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="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">"meta_data"</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/v2/products/799"</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/v2/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/v2/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/products/794 <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/794</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/794'</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/794"</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/794"</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">794</span><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-19"</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-19/"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">53</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">40</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">56</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">479</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">99</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">792</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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/2017/03/T_2_front-4.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">793</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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/2017/03/T_2_back-2.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">"meta_data"</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/v2/products/794"</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/v2/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/v2/products</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/products <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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">799</span><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-22"</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-22/"</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">"2017-03-23T17:03:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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">"2017-03-23T17:03:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:12"</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">""</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><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">false</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">"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">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">369</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">414</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">56</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">795</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">"2017-03-23T14:03:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:08"</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">"2017-03-23T14:03:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:08"</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/2017/03/T_4_front-11.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">796</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">"2017-03-23T14:03:09"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:09"</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">"2017-03-23T14:03:09"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:09"</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/2017/03/T_4_back-10.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">797</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">"2017-03-23T14:03:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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">"2017-03-23T14:03:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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/2017/03/T_3_front-10.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">798</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">"2017-03-23T14:03:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:11"</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">"2017-03-23T14:03:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:11"</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/2017/03/T_3_back-10.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">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">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="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">"meta_data"</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/v2/products/799"</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/v2/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">794</span><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-19"</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-19/"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">463</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">47</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">387</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">458</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">792</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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/2017/03/T_2_front-4.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">793</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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/2017/03/T_2_back-2.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="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="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">"meta_data"</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/v2/products/794"</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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>. Default is <code>date</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to those of particular parent IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_exclude</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to all items except those of a particular parent ID.</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. Options: <code>any</code>, <code>draft</code>, <code>pending</code>, <code>private</code> and <code>publish</code>. Default is <code>any</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific type. Options: <code>simple</code>, <code>grouped</code>, <code>external</code> and <code>variable</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific SKU.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>featured</code></td>
|
|
<td>boolean</td>
|
|
<td>Limit result set to featured products.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>category</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific category ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tag</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific tag ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific shipping class ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribute</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific attribute.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribute_term</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific attribute term ID (required an assigned attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific tax class. Default options: <code>standard</code>, <code>reduced-rate</code> and <code>zero-rate</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>in_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Limit result set to products in stock or out of stock.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>on_sale</code></td>
|
|
<td>boolean</td>
|
|
<td>Limit result set to products on sale.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>min_price</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products based on a minimum price.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>max_price</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products based on a maximum price.</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/v2/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v2/products/794 <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/794</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/794'</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/794"</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/794"</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">794</span><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-19"</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-19/"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">479</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">387</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">463</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">396</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">792</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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/2017/03/T_2_front-4.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">793</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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/2017/03/T_2_back-2.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">"meta_data"</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/v2/products/794"</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/v2/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/v2/products/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/products/794?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/794</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/794'</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/794"</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/794"</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">794</span><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-19"</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-19/"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">479</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">387</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">463</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">396</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">792</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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/2017/03/T_2_front-4.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">793</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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/2017/03/T_2_back-2.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">"meta_data"</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/v2/products/794"</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/v2/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/v2/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/v2/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": 799,
|
|
"default_attributes": [
|
|
{
|
|
"id": 6,
|
|
"name": "Color",
|
|
"option": "Green"
|
|
},
|
|
{
|
|
"id": 0,
|
|
"name": "Size",
|
|
"option": "M"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"delete": [
|
|
794
|
|
]
|
|
}'</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">799</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">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">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">id</span><span class="p">:</span> <span class="mi">0</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="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">794</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">799</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">'name'</span> <span class="o">=></span> <span class="s1">'Color'</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'Green'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">0</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="s1">'delete'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="mi">794</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">799</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">"name"</span><span class="p">:</span> <span class="s">"Color,
|
|
"</span><span class="n">option</span><span class="s">": "</span><span class="n">Green</span><span class="s">"
|
|
},
|
|
{
|
|
"</span><span class="nb">id</span><span class="s">": 0,
|
|
"</span><span class="n">name</span><span class="s">": "</span><span class="n">Size</span><span class="s">",
|
|
"</span><span class="n">option</span><span class="s">": "</span><span class="n">M</span><span class="s">"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"</span><span class="n">delete</span><span class="s">": [
|
|
794
|
|
]
|
|
}
|
|
|
|
print(wcapi.post("</span><span class="n">products</span><span class="o">/</span><span class="n">batch</span><span class="s">", data).json())
|
|
</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">799</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">name: </span><span class="s2">"Color,
|
|
option: "</span><span class="no">Green</span><span class="s2">"
|
|
},
|
|
{
|
|
id: 0,
|
|
name: "</span><span class="no">Size</span><span class="s2">",
|
|
option: "</span><span class="no">M</span><span class="s2">"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
delete: [
|
|
794
|
|
]
|
|
}
|
|
|
|
woocommerce.post("</span><span class="n">products</span><span class="o">/</span><span class="n">batch</span><span class="s2">", data).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">801</span><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-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/woo-single-1-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">"2017-03-23T17:35:43"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:43"</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">"2017-03-23T17:35:43"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:43"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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="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">"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">"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="mi">588</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">87</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">573</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">96</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">329</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">800</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">"2017-03-23T14:35:43"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:43"</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">"2017-03-23T14:35:43"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:43"</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/2017/03/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">"meta_data"</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/v2/products/801"</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/v2/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">804</span><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">"2017-03-23T17:35:48"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:48"</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">"2017-03-23T17:35:48"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:48"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">458</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">56</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">99</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">378</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">802</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">"2017-03-23T14:35:47"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:47"</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">"2017-03-23T14:35:47"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:47"</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/2017/03/T_2_front-5.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">803</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">"2017-03-23T14:35:48"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:48"</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">"2017-03-23T14:35:48"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:35:48"</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/2017/03/T_2_back-3.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">"meta_data"</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/v2/products/804"</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/v2/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">799</span><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-22"</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-22/"</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">"2017-03-23T17:03:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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">"2017-03-23T17:03:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:12"</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">""</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><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">false</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">"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">414</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">40</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">34</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">463</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">15</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">795</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">"2017-03-23T14:03:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:08"</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">"2017-03-23T14:03:08"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:08"</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/2017/03/T_4_front-11.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">796</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">"2017-03-23T14:03:09"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:09"</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">"2017-03-23T14:03:09"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:09"</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/2017/03/T_4_back-10.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">797</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">"2017-03-23T14:03:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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">"2017-03-23T14:03:10"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03: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/2017/03/T_3_front-10.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">798</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">"2017-03-23T14:03:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:11"</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">"2017-03-23T14:03:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:03:11"</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/2017/03/T_3_back-10.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">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">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">"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="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">"meta_data"</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/v2/products/799"</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/v2/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">794</span><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-19"</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-19/"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T17:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price_html"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<span class=</span><span class="se">\"</span><span class="s2">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">>&#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">"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">369</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">56</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">378</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">31</span><span class="p">,</span><span class="w">
|
|
</span><span class="mi">22</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"upsell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"cross_sell_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"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">792</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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">"2017-03-23T14:01:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:13"</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/2017/03/T_2_front-4.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">793</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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">"2017-03-23T14:01:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T20:01:14"</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/2017/03/T_2_back-2.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">"meta_data"</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/v2/products/794"</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/v2/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/v2/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/v2/products/22/reviews/5 <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/products/22/reviews/5</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/22/reviews/5'</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/products/22/reviews/5"</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/products/22/reviews/5"</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">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">"2013-06-07T11:43:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-06-07T11:43:13"</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">"Nice T-shirt, I got one in black. Goes with anything!"</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">4</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"James Koster"</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">"james@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/v2/products/22/reviews/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/v2/products/22/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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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='product-review-properties'>Product review 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>review</code></td>
|
|
<td>string</td>
|
|
<td>The content of the review. <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the review was created, in the site's timezone.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the review was created, as GMT.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rating</code></td>
|
|
<td>integer</td>
|
|
<td>Review rating (0 to 5).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Reviewer name. <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>email</code></td>
|
|
<td>string</td>
|
|
<td>Reviewer email. <i class="label label-info">mandatory</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/v2/products/<product_id>/reviews</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/products/22/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/22/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/22/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/22/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/22/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">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">"2013-06-07T11:43:13"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-06-07T11:43:13"</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">"Nice T-shirt, I got one in black. Goes with anything!"</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">4</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"James Koster"</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">"james@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/v2/products/22/reviews/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/v2/products/22/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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><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">"2013-06-07T11:55:15"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-06-07T11:55:15"</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">"Very comfortable shirt, and I love the graphic!"</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">4</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cobus Bester"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bester@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/v2/products/22/reviews/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/v2/products/22/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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><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">"2013-06-07T13:02:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-06-07T13:02:14"</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">"Great T-shirt quality, Great Design and Great Service."</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/v2/products/22/reviews/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/v2/products/22/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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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-variations'>Product variations</h1>
|
|
<p>The product variations API allows you to create, view, update, and delete individual, or a batch, of product variations.</p>
|
|
<h2 id='product-variation-properties'>Product variation 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 variation was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the variation was created, as GMT. <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the variation was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Variation description.</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. <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>date-time</td>
|
|
<td>Start date of sale price, in the site's timezone.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_from_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>Start date of sale price, as GMT.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_to</code></td>
|
|
<td>date-time</td>
|
|
<td>End date of sale price, in the site's timezone.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_on_sale_to_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>End date of sale price, as GMT.</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>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>true</code>.</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>virtual</code></td>
|
|
<td>boolean</td>
|
|
<td>If the variation is virtual. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloadable</code></td>
|
|
<td>boolean</td>
|
|
<td>If the variation is downloadable. Default is <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>downloads</code></td>
|
|
<td>array</td>
|
|
<td>List of downloadable files. See <a href="#product-variation-downloads-properties">Product variation - Downloads properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_limit</code></td>
|
|
<td>integer</td>
|
|
<td>Number of times downloadable files can be downloaded after purchase. Default is <code>-1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>download_expiry</code></td>
|
|
<td>integer</td>
|
|
<td>Number of days until access to downloadable files expires. Default is <code>-1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_status</code></td>
|
|
<td>string</td>
|
|
<td>Tax status. Options: <code>taxable</code>, <code>shipping</code> and <code>none</code>. Default is <code>taxable</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.</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. Options: <code>no</code>, <code>notify</code> and <code>yes</code>. Default is <code>no</code>.</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 the variation is on backordered. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>weight</code></td>
|
|
<td>string</td>
|
|
<td>Variation weight.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dimensions</code></td>
|
|
<td>object</td>
|
|
<td>Variation dimensions. See <a href="#product-variation-dimensions-properties">Product variation - Dimensions properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Shipping class slug.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class_id</code></td>
|
|
<td>string</td>
|
|
<td>Shipping class ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>image</code></td>
|
|
<td>object</td>
|
|
<td>Variation image data. See <a href="#product-variation-image-properties">Product variation - Image properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attributes</code></td>
|
|
<td>array</td>
|
|
<td>List of attributes. See <a href="#product-variation-attributes-properties">Product variation - Attributes properties</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>menu_order</code></td>
|
|
<td>integer</td>
|
|
<td>Menu order, used to custom sort products.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>meta_data</code></td>
|
|
<td>array</td>
|
|
<td>Meta data. See <a href="#product-variation-meta-data-properties">Product variation - Meta data properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-variation-downloads-properties'>Product variation - Downloads properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>id</code></td>
|
|
<td>string</td>
|
|
<td>File ID.</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.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-variation-dimensions-properties'>Product variation - Dimensions properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>length</code></td>
|
|
<td>string</td>
|
|
<td>Variation length.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>width</code></td>
|
|
<td>string</td>
|
|
<td>Variation width.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>height</code></td>
|
|
<td>string</td>
|
|
<td>Variation height.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-variation-image-properties'>Product variation - 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.</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_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was created, as GMT. <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>src</code></td>
|
|
<td>string</td>
|
|
<td>Image URL.</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. 0 means that the image is featured.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-variation-attributes-properties'>Product variation - Attributes 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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Attribute name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>option</code></td>
|
|
<td>string</td>
|
|
<td>Selected attribute term name.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='product-variation-meta-data-properties'>Product variation - Meta data 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>Meta ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>string</td>
|
|
<td>Meta key.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Meta value.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-product-variation'>Create a product variation</h2>
|
|
<p>This API helps you to create a new product variation.</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/v2/products/<product_id>/variations</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>JSON response example:</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/v2/products/22/variations <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": "9.00",
|
|
"image": {
|
|
"id": 423
|
|
},
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "Black"
|
|
}
|
|
]
|
|
}'</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">9.00</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">id</span><span class="p">:</span> <span class="mi">423</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">9</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="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/22/variations</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">'9.00'</span><span class="p">,</span>
|
|
<span class="s1">'image'</span> <span class="o">=></span> <span class="p">[</span>
|
|
<span class="s1">'id'</span> <span class="o">=></span> <span class="mi">423</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">9</span><span class="p">,</span>
|
|
<span class="s1">'option'</span> <span class="o">=></span> <span class="s1">'Black'</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
<span class="p">];</span>
|
|
|
|
<span class="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/22/variations'</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">"9.00"</span><span class="p">,</span>
|
|
<span class="s">"image"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s">"id"</span><span class="p">:</span> <span class="mi">423</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">9</span><span class="p">,</span>
|
|
<span class="s">"option"</span><span class="p">:</span> <span class="s">"Black"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="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/22/variations"</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">"9.00"</span><span class="p">,</span>
|
|
<span class="ss">image: </span><span class="p">{</span>
|
|
<span class="ss">id: </span><span class="mi">423</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">9</span><span class="p">,</span>
|
|
<span class="ss">position: </span><span class="s2">"Black"</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/22/variations"</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">732</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</span><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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">423</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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/10/T_4_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/732"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-variation'>Retrieve a product variation</h2>
|
|
<p>This API lets you retrieve and view a specific product variation 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/v2/products/<product_id>/variations/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/products/22/variations/732 <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/22/variations/732</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/22/variations/732'</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/22/variations/732"</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/22/variations/732"</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">732</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</span><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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">423</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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/10/T_4_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/732"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-variations'>List all product variations</h2>
|
|
<p>This API helps you to view all the product variations.</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/v2/products/<product_id>/variations</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/products/22/variations <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/22/variations</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/22/variations'</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/22/variations"</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/22/variations"</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">733</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53:11"</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53: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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=green"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">425</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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21: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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:16"</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/10/T_3_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/733"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">732</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</span><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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">423</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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/10/T_4_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/732"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>. Default is <code>date</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to those of particular parent IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_exclude</code></td>
|
|
<td>array</td>
|
|
<td>Limit result set to all items except those of a particular parent ID.</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. Options: <code>any</code>, <code>draft</code>, <code>pending</code>, <code>private</code> and <code>publish</code>. Default is <code>any</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific type. Options: <code>simple</code>, <code>grouped</code>, <code>external</code> and <code>variable</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sku</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific SKU.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>featured</code></td>
|
|
<td>boolean</td>
|
|
<td>Limit result set to featured products.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>category</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific category ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tag</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific tag ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>shipping_class</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products assigned a specific shipping class ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribute</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific attribute.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribute_term</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific attribute term ID (required an assigned attribute).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tax_class</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products with a specific tax class. Default options: <code>standard</code>, <code>reduced-rate</code> and <code>zero-rate</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>in_stock</code></td>
|
|
<td>boolean</td>
|
|
<td>Limit result set to products in stock or out of stock.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>on_sale</code></td>
|
|
<td>boolean</td>
|
|
<td>Limit result set to products on sale.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>min_price</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products based on a minimum price.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>max_price</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to products based on a maximum price.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='update-a-product-variation'>Update a product variation</h2>
|
|
<p>This API lets you make changes to a product variation.</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/v2/products/<product_id>/variations/<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/v2/products/22/variations/733 <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": "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">regular_price</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="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">"</span><span class="s2">products/22/variations/733</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">'10.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">put</span><span class="p">(</span><span class="s1">'products/22/variations/733'</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">"10.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">put</span><span class="p">(</span><span class="s">"products/22/variations/733"</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">"10.00"</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/22/variations/733"</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">733</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53:11"</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53: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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=green"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</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">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">425</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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21: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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:16"</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/10/T_3_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/733"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-variation'>Delete a product variation</h2>
|
|
<p>This API helps you delete a product variation.</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/v2/products/<product_id>/variations/<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/v2/products/22/variations/733?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/22/variations/733</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/22/variations/733'</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/22/variations/733"</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/22/variations/733"</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">733</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53:11"</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53: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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=green"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</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">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">425</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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21: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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:16"</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/10/T_3_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/733"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-variations'>Batch update product variations</h2>
|
|
<p>This API helps you to batch create, update and delete multiple product variations.</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/v2/products/<product_id>/variations/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/v2/products/22/variations/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": [
|
|
{
|
|
"regular_price": "10.00",
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "Blue"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"regular_price": "10.00",
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "White"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 733,
|
|
"regular_price": "10.00"
|
|
}
|
|
],
|
|
"delete": [
|
|
732
|
|
]
|
|
}'</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">regular_price</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="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">Blue</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">10.00</span><span class="dl">"</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">White</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">733</span><span class="p">,</span>
|
|
<span class="na">regular_price</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="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">732</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/22/variations/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">'regular_price'</span> <span class="o">=></span> <span class="s1">'10.00'</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">'Blue'</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">'10.00'</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">'White'</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">733</span><span class="p">,</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'10.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">732</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/22/variations/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">"regular_price"</span><span class="p">:</span> <span class="s">"10.00"</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">"Blue"</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">"10.00"</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">"White"</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">733</span><span class="p">,</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"10.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">732</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/22/variations/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">regular_price: </span><span class="s2">"10.00"</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">"Blue"</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">"10.00"</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">"White"</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">733</span><span class="p">,</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"10.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">732</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/22/variations/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">735</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">"2017-03-23T01:19:37"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:37"</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">"2017-03-23T01:19:37"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:37"</span><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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=blue"</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">"10.00"</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">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T22:19:40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:40"</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">"2017-03-22T22:19:40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:40"</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/plugins/woocommerce/assets/images/placeholder.png"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Placeholder"</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">"Placeholder"</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="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">"Blue"</span><span class="w">
|
|
</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">"meta_data"</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/v2/products/22/variations/735"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">736</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">"2017-03-23T01:19:40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:40"</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">"2017-03-23T01:19:40"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:40"</span><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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=white"</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">"10.00"</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">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="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">"date_created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-22T22:19:42"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:42"</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">"2017-03-22T22:19:42"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T04:19:42"</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/plugins/woocommerce/assets/images/placeholder.png"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Placeholder"</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">"Placeholder"</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="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">"White"</span><span class="w">
|
|
</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">"meta_data"</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/v2/products/22/variations/736"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</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">733</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53:11"</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">"2017-03-23T00:53:11"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:53: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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=green"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.00"</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">"10.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">425</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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21: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-10-19T12:21:16"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:16"</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/10/T_3_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/733"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</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">732</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</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">"2017-03-23T00:36:38"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:36:38"</span><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">"permalink"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/product/ship-your-idea/?attribute_pa_color=black"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sku"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"price"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9.00"</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">"9.00"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sale_price"</span><span class="p">:</span><span class="w"> </span><span class="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="kc">null</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_on_sale_from_gmt"</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_on_sale_to"</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_on_sale_to_gmt"</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">"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">"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">"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="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">423</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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-10-19T12:21:14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-10-19T16:21:14"</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/10/T_4_front-12.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="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">"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">"meta_data"</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/v2/products/22/variations/732"</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/v2/products/22/variations"</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/v2/products/22"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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">mandatory</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. By default only <code>select</code> is supported.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order_by</code></td>
|
|
<td>string</td>
|
|
<td>Default sort order. Options: <code>menu_order</code>, <code>name</code>, <code>name_num</code> and <code>id</code>. Default is <code>menu_order</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/v2/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/v2/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/v2/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/v2/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/v2/products/attributes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/products/attributes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/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/v2/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><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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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-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-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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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='product-attribute-term-properties'>Product 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">mandatory</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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>asc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by resource attribute. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>. Default is <code>name</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>boolean</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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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">mandatory</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. Options: <code>default</code>, <code>products</code>, <code>subcategories</code> and <code>both</code>. Default is <code>default</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>image</code></td>
|
|
<td>object</td>
|
|
<td>Image data. See <a href="#product-category-image-properties">Product 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='product-category-image-properties'>Product 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.</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_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was created, as GMT <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>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the image was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>src</code></td>
|
|
<td>string</td>
|
|
<td>Image URL.</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/v2/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/v2/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">730</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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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/2017/03/T_2_front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="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">36</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/v2/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/v2/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/v2/products/categories/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/products/categories/9 <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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">730</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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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/2017/03/T_2_front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="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">36</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/v2/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/v2/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/v2/products/categories</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/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">730</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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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/2017/03/T_2_front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="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">36</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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>asc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by resource attribute. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>. Default is <code>name</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>boolean</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/v2/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/v2/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">730</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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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/2017/03/T_2_front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="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">36</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/v2/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/v2/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/v2/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/v2/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">730</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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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">"2017-03-23T00:01:07"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-23T03:01: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/2017/03/T_2_front.jpg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"alt"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="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">36</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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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='product-shipping-class-properties'>Product 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">mandatory</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/v2/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/v2/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/v2/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/v2/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/v2/products/shipping_classes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/products/shipping_classes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>asc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by resource attribute. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>. Default is <code>name</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>boolean</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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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">mandatory</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/v2/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/v2/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/v2/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/v2/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/v2/products/tags/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/products/tags</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific ids.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>asc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by resource attribute. Options: <code>id</code>, <code>include</code>, <code>name</code>, <code>slug</code>, <code>term_group</code>, <code>description</code> and <code>count</code>. Default is <code>name</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_empty</code></td>
|
|
<td>boolean</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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/reports</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/reports <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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/v2/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/v2/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/v2/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/v2/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/v2/reports/sales</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/reports/top_sellers</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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="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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/taxes/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/taxes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/taxes/classes</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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-Source</code>: <code>http://example.com/</code>.</li>
|
|
<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-Webhook-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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Webhook status. Options: <code>active</code>, <code>paused</code> and <code>disabled</code>. Default is <code>active</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>topic</code></td>
|
|
<td>string</td>
|
|
<td>Webhook topic. <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>resource</code></td>
|
|
<td>string</td>
|
|
<td>Webhook resource. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>event</code></td>
|
|
<td>string</td>
|
|
<td>Webhook event. <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">read-only</i> <i class="label label-info">mandatory</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. This will default is a MD5 hash from the current user's ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the webhook was created, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the webhook was created, as GMT. <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 webhook was last modified, in the site's timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>date_modified_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the webhook was last modified, as GMT. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='webhook-delivery-properties'>Webhook 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. <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>
|
|
<tr>
|
|
<td><code>date_created_gmt</code></td>
|
|
<td>date-time</td>
|
|
<td>The date the webhook delivery was logged, GMT. <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-Source</code></td>
|
|
<td>string</td>
|
|
<td>The webhook source. <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/v2/webhooks</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST https://example.com/wp-json/wc/v2/webhooks <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret <span class="se">\</span>
|
|
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
|
<span class="nt">-d</span> <span class="s1">'{
|
|
"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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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/v2/webhooks/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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/v2/webhooks</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/webhooks <span class="se">\</span>
|
|
<span class="nt">-u</span> consumer_key:consumer_secret
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="nx">WooCommerce</span><span class="p">.</span><span class="kd">get</span><span class="p">(</span><span class="dl">"</span><span class="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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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>. Default is <code>view</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page</code></td>
|
|
<td>integer</td>
|
|
<td>Current page of the collection. Default is <code>1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>per_page</code></td>
|
|
<td>integer</td>
|
|
<td>Maximum number of items to be returned in result set. Default is <code>10</code>.</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>array</td>
|
|
<td>Ensure result set excludes specific IDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>include</code></td>
|
|
<td>array</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. Options: <code>asc</code> and <code>desc</code>. Default is <code>desc</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>orderby</code></td>
|
|
<td>string</td>
|
|
<td>Sort collection by object attribute. Options: <code>date</code>, <code>id</code>, <code>include</code>, <code>title</code> and <code>slug</code>. Default is <code>date</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>status</code></td>
|
|
<td>string</td>
|
|
<td>Limit result set to webhooks assigned a specific status. Options: <code>all</code>, <code>active</code>, <code>paused</code> and <code>disabled</code>. Default is <code>all</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/v2/webhook/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT https://example.com/wp-json/wc/v2/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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T17:30:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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/v2/webhooks/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE https://example.com/wp-json/wc/v2/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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T23:30:12"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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, Default 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/v2/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/v2/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-25T01:56:26"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-25T01:56:26"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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-25T01:56:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-25T01:56:30"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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-15T23:17:52"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_modified_gmt"</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/v2/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/v2/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/v2/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/v2/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-16T06:30:31"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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/v2/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/v2/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/v2/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/v2/webhooks/<id>/deliveries</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/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-16T06:30:31"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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/v2/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/v2/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/v2/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-16T06:29:19"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"date_created_gmt"</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/v2/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/v2/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/v2/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><h1 id='settings'>Settings</h1>
|
|
<p>The settings API allows you to view all groups of settings available.</p>
|
|
<h2 id='setting-group-properties'>Setting group properties</h2>
|
|
<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>A unique identifier that can be used to link settings together. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>label</code></td>
|
|
<td>string</td>
|
|
<td>A human readable label for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>A human readable description for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_id</code></td>
|
|
<td>string</td>
|
|
<td>ID of parent grouping. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>sub_groups</code></td>
|
|
<td>string</td>
|
|
<td>IDs for settings sub groups. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='list-all-settings-groups'>List all settings groups</h2>
|
|
<p>This API helps you to view all the settings groups.</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/v2/settings</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/settings <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">settings</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">'settings'</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">"settings"</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">"settings"</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="s2">"general"</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">"General"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"products"</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">"Products"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/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="s2">"tax"</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">"Tax"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/tax"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"shipping"</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">"Shipping"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/shipping"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"checkout"</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">"Checkout"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/checkout"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"account"</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">"Accounts"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/account"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email"</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">"Emails"</span><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">"parent_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">"sub_groups"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="s2">"email_new_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_cancelled_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_failed_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_on_hold_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_processing_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_completed_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_refunded_order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_invoice"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_note"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_reset_password"</span><span class="p">,</span><span class="w">
|
|
</span><span class="s2">"email_customer_new_account"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"integration"</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">"Integration"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/integration"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"api"</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">"API"</span><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">"parent_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">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/api"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_new_order"</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">"New order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New order emails are sent to chosen recipient(s) when a new order is received."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_new_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_cancelled_order"</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">"Cancelled order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cancelled order emails are sent to chosen recipient(s) when orders have been marked cancelled (if they were previously processing or on-hold)."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_cancelled_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_failed_order"</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">"Failed order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Failed order emails are sent to chosen recipient(s) when orders have been marked failed (if they were previously processing or on-hold)."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_failed_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_on_hold_order"</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">"Order on-hold"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This is an order notification sent to customers containing order details after an order is placed on-hold."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_on_hold_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_processing_order"</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">"Processing order"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This is an order notification sent to customers containing order details after payment."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_processing_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_completed_order"</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">"Completed order"</span><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 complete emails are sent to customers when their orders are marked completed and usually indicate that their orders have been shipped."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_completed_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_refunded_order"</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">"Refunded order"</span><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 refunded emails are sent to customers when their orders are marked refunded."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_refunded_order"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_invoice"</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">"Customer invoice"</span><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 invoice emails can be sent to customers containing their order information and payment links."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_invoice"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_note"</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">"Customer note"</span><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 note emails are sent when you add a note to an order."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_note"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_reset_password"</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">"Reset password"</span><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 </span><span class="se">\"</span><span class="s2">reset password</span><span class="se">\"</span><span class="s2"> emails are sent when customers reset their passwords."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_reset_password"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"email_customer_new_account"</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">"New account"</span><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 </span><span class="se">\"</span><span class="s2">new account</span><span class="se">\"</span><span class="s2"> emails are sent to the customer when a customer signs up via checkout or account pages."</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="s2">"email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"sub_groups"</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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/settings/email_customer_new_account"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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='setting-options'>Setting options</h1><h2 id='setting-option-properties'>Setting option properties</h2>
|
|
<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>A unique identifier for the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>label</code></td>
|
|
<td>string</td>
|
|
<td>A human readable label for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>A human readable description for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>mixed</td>
|
|
<td>Setting value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default</code></td>
|
|
<td>mixed</td>
|
|
<td>Default value for the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tip</code></td>
|
|
<td>string</td>
|
|
<td>Additional help text shown to the user about the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>placeholder</code></td>
|
|
<td>string</td>
|
|
<td>Placeholder text to be displayed in text inputs. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Type of setting. Options: <code>text</code>, <code>email</code>, <code>number</code>, <code>color</code>, <code>password</code>, <code>textarea</code>, <code>select</code>, <code>multiselect</code>, <code>radio</code>, <code>image_width</code> and <code>checkbox</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>options</code></td>
|
|
<td>object</td>
|
|
<td>Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='retrieve-an-setting-option'>Retrieve an setting option</h2>
|
|
<p>This API lets you retrieve and view a specific setting option.</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/v2/settings/<group_id>/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/settings/general/woocommerce_allowed_countries <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">settings/general/woocommerce_allowed_countries</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">'settings/general/woocommerce_allowed_countries'</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">"settings/general/woocommerce_allowed_countries"</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">"settings/general/woocommerce_allowed_countries"</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="s2">"woocommerce_allowed_countries"</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">"Selling location(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">"This option lets you limit which countries you are willing to sell to."</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">"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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"all"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"all_except"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries, except for&hellip;"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"specific"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to specific countries"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This option lets you limit which countries you are willing to sell to."</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">"all"</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/v2/settings/general/woocommerce_allowed_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-setting-options'>List all setting options</h2>
|
|
<p>This API helps you to view all the setting options.</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/v2/settings/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/settings/general <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">settings/general</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">'settings/general'</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">"settings/general"</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">"settings/general"</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="s2">"woocommerce_allowed_countries"</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">"Selling location(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">"This option lets you limit which countries you are willing to sell to."</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">"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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"all"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"all_except"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries, except for&hellip;"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"specific"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to specific countries"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This option lets you limit which countries you are willing to sell to."</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">"all"</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/v2/settings/general/woocommerce_allowed_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_all_except_countries"</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">"Sell to all countries, except for&hellip;"</span><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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"multiselect"</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">""</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">""</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="nl">"AX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&#197;land Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Afghanistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Albania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Algeria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"American Samoa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Andorra"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Angola"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Anguilla"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Antarctica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Antigua and Barbuda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Argentina"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Armenia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Aruba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Australia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Austria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Azerbaijan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahamas"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahrain"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bangladesh"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Barbados"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belarus"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belgium"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belize"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Benin"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bermuda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bhutan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bolivia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bonaire, Saint Eustatius and Saba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bosnia and Herzegovina"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Botswana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bouvet Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brazil"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"British Indian Ocean Territory"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"British Virgin Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brunei"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bulgaria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burkina Faso"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burundi"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cambodia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cameroon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Canada"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cape Verde"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cayman Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Central African Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chad"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chile"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"China"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Christmas Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cocos (Keeling) Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Colombia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Comoros"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congo (Brazzaville)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congo (Kinshasa)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cook Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Costa Rica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Croatia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cura&ccedil;ao"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cyprus"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Czech Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Denmark"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Djibouti"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominican Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ecuador"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Egypt"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"El Salvador"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Equatorial Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ER"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Eritrea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Estonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ET"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ethiopia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Falkland Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Faroe Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fiji"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Finland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"France"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Guiana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Polynesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Southern Territories"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gabon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gambia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Georgia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Germany"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ghana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gibraltar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Greece"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Greenland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Grenada"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guadeloupe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guam"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guatemala"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guernsey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinea-Bissau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guyana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Haiti"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Heard Island and McDonald Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Honduras"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hong Kong"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hungary"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iceland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"India"</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">"Indonesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iran"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iraq"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ireland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Isle of Man"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Israel"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Italy"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ivory Coast"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jamaica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Japan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jersey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jordan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kazakhstan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kenya"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kiribati"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kuwait"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kyrgyzstan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Laos"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Latvia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lebanon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lesotho"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liberia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Libya"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liechtenstein"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lithuania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Luxembourg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macao S.A.R., China"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macedonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Madagascar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malawi"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malaysia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maldives"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ML"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mali"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Marshall Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Martinique"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritius"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mayotte"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mexico"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Micronesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moldova"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Monaco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mongolia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ME"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Montenegro"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Montserrat"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Morocco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozambique"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Myanmar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Namibia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nauru"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nepal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Netherlands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Caledonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Zealand"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nicaragua"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niger"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nigeria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niue"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norfolk Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"North Korea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Northern Mariana Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norway"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"OM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Oman"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pakistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Palestinian Territory"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Panama"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Papua New Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Paraguay"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Peru"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Philippines"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pitcairn"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Poland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Portugal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Puerto Rico"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"QA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qatar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reunion"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Romania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Russia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rwanda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ST"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S&atilde;o Tom&eacute; and Pr&iacute;ncipe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Barth&eacute;lemy"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Helena"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Kitts and Nevis"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Lucia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Martin (Dutch part)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Martin (French part)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Pierre and Miquelon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Vincent and the Grenadines"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Samoa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Marino"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saudi Arabia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Senegal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Serbia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Seychelles"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sierra Leone"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Singapore"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Slovakia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Slovenia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Solomon Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Somalia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Africa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Georgia/Sandwich Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Korea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Sudan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ES"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Spain"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sri Lanka"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sudan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Suriname"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Svalbard and Jan Mayen"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swaziland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sweden"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Switzerland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Syria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Taiwan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tajikistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tanzania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thailand"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Timor-Leste"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Togo"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tokelau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tonga"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Trinidad and Tobago"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tunisia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkmenistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turks and Caicos Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tuvalu"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uganda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ukraine"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Arab Emirates"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Kingdom (UK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"US"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US) Minor Outlying Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US) Virgin Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uruguay"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uzbekistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vanuatu"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vatican"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Venezuela"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vietnam"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wallis and Futuna"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Western Sahara"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Yemen"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zambia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zimbabwe"</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/v2/settings/general/woocommerce_all_except_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_specific_allowed_countries"</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">"Sell to specific countries"</span><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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"multiselect"</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">""</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">""</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="nl">"AX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&#197;land Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Afghanistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Albania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Algeria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"American Samoa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Andorra"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Angola"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Anguilla"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Antarctica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Antigua and Barbuda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Argentina"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Armenia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Aruba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Australia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Austria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Azerbaijan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahamas"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahrain"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bangladesh"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Barbados"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belarus"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belgium"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belize"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Benin"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bermuda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bhutan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bolivia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bonaire, Saint Eustatius and Saba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bosnia and Herzegovina"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Botswana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bouvet Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brazil"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"British Indian Ocean Territory"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"British Virgin Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brunei"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bulgaria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burkina Faso"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burundi"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cambodia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cameroon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Canada"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cape Verde"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cayman Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Central African Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chad"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chile"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"China"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Christmas Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cocos (Keeling) Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Colombia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Comoros"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congo (Brazzaville)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congo (Kinshasa)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cook Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Costa Rica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Croatia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cura&ccedil;ao"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cyprus"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Czech Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Denmark"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Djibouti"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominican Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ecuador"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Egypt"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"El Salvador"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Equatorial Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ER"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Eritrea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Estonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ET"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ethiopia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Falkland Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Faroe Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fiji"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Finland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"France"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Guiana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Polynesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Southern Territories"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gabon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gambia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Georgia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Germany"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ghana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gibraltar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Greece"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Greenland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Grenada"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guadeloupe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guam"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guatemala"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guernsey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinea-Bissau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guyana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Haiti"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Heard Island and McDonald Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Honduras"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hong Kong"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hungary"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iceland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"India"</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">"Indonesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iran"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iraq"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ireland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Isle of Man"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Israel"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Italy"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ivory Coast"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jamaica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Japan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jersey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jordan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kazakhstan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kenya"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kiribati"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kuwait"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kyrgyzstan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Laos"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Latvia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lebanon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lesotho"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liberia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Libya"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liechtenstein"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lithuania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Luxembourg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macao S.A.R., China"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macedonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Madagascar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malawi"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malaysia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maldives"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ML"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mali"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Marshall Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Martinique"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritius"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mayotte"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mexico"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Micronesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moldova"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Monaco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mongolia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ME"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Montenegro"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Montserrat"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Morocco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozambique"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Myanmar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Namibia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nauru"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nepal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Netherlands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Caledonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Zealand"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nicaragua"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niger"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nigeria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niue"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norfolk Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"North Korea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Northern Mariana Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norway"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"OM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Oman"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pakistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Palestinian Territory"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Panama"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Papua New Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Paraguay"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Peru"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Philippines"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pitcairn"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Poland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Portugal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Puerto Rico"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"QA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qatar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reunion"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Romania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Russia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rwanda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ST"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S&atilde;o Tom&eacute; and Pr&iacute;ncipe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Barth&eacute;lemy"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Helena"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Kitts and Nevis"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Lucia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Martin (Dutch part)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Martin (French part)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Pierre and Miquelon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Vincent and the Grenadines"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Samoa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Marino"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saudi Arabia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Senegal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Serbia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Seychelles"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sierra Leone"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Singapore"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Slovakia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Slovenia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Solomon Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Somalia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Africa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Georgia/Sandwich Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Korea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Sudan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ES"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Spain"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sri Lanka"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sudan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Suriname"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Svalbard and Jan Mayen"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swaziland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sweden"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Switzerland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Syria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Taiwan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tajikistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tanzania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thailand"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Timor-Leste"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Togo"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tokelau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tonga"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Trinidad and Tobago"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tunisia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkmenistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turks and Caicos Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tuvalu"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uganda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ukraine"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Arab Emirates"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Kingdom (UK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"US"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US) Minor Outlying Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US) Virgin Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uruguay"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uzbekistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vanuatu"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vatican"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Venezuela"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vietnam"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wallis and Futuna"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Western Sahara"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Yemen"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zambia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zimbabwe"</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/v2/settings/general/woocommerce_specific_allowed_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_ship_to_countries"</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">"Shipping location(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">"Choose which countries you want to ship to, or choose to ship to all locations you sell to."</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">""</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship to all countries you sell to"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"all"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship to all countries"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"specific"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ship to specific countries only"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"disabled"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Disable shipping &amp; shipping calculations"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Choose which countries you want to ship to, or choose to ship to all locations you sell to."</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">""</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/v2/settings/general/woocommerce_ship_to_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_specific_ship_to_countries"</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">"Ship to specific countries"</span><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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"multiselect"</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">""</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">""</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="nl">"AX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&#197;land Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Afghanistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Albania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Algeria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"American Samoa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Andorra"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Angola"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Anguilla"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Antarctica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Antigua and Barbuda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Argentina"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Armenia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Aruba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Australia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Austria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Azerbaijan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahamas"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahrain"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bangladesh"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Barbados"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belarus"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belgium"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belize"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Benin"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bermuda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bhutan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bolivia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bonaire, Saint Eustatius and Saba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bosnia and Herzegovina"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Botswana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bouvet Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brazil"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"British Indian Ocean Territory"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"British Virgin Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brunei"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bulgaria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burkina Faso"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burundi"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cambodia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cameroon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Canada"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cape Verde"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cayman Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Central African Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chad"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chile"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"China"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Christmas Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cocos (Keeling) Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Colombia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Comoros"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congo (Brazzaville)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congo (Kinshasa)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cook Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Costa Rica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Croatia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuba"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cura&ccedil;ao"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cyprus"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Czech Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Denmark"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Djibouti"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominican Republic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ecuador"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Egypt"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"El Salvador"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Equatorial Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ER"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Eritrea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Estonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ET"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ethiopia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Falkland Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Faroe Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fiji"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Finland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"France"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Guiana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Polynesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"French Southern Territories"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gabon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gambia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Georgia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Germany"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ghana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gibraltar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Greece"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Greenland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Grenada"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guadeloupe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guam"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guatemala"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guernsey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinea-Bissau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guyana"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Haiti"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Heard Island and McDonald Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Honduras"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hong Kong"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hungary"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iceland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"India"</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">"Indonesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iran"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iraq"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ireland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Isle of Man"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Israel"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Italy"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ivory Coast"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jamaica"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Japan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jersey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jordan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kazakhstan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kenya"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kiribati"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kuwait"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kyrgyzstan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Laos"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Latvia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lebanon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lesotho"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liberia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Libya"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liechtenstein"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lithuania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Luxembourg"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macao S.A.R., China"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macedonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Madagascar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malawi"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malaysia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maldives"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ML"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mali"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malta"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Marshall Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Martinique"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritius"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mayotte"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mexico"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Micronesia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moldova"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Monaco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mongolia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ME"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Montenegro"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Montserrat"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Morocco"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozambique"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Myanmar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Namibia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nauru"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nepal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Netherlands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Caledonia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Zealand"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nicaragua"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niger"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nigeria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Niue"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norfolk Island"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"North Korea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Northern Mariana Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norway"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"OM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Oman"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pakistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Palestinian Territory"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Panama"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Papua New Guinea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Paraguay"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Peru"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Philippines"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pitcairn"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Poland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Portugal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Puerto Rico"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"QA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qatar"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reunion"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Romania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Russia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rwanda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ST"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S&atilde;o Tom&eacute; and Pr&iacute;ncipe"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Barth&eacute;lemy"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Helena"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Kitts and Nevis"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Lucia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Martin (Dutch part)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Martin (French part)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Pierre and Miquelon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Vincent and the Grenadines"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Samoa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"San Marino"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saudi Arabia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Senegal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Serbia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Seychelles"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sierra Leone"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Singapore"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Slovakia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Slovenia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Solomon Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Somalia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Africa"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Georgia/Sandwich Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Korea"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Sudan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ES"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Spain"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sri Lanka"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sudan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Suriname"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Svalbard and Jan Mayen"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swaziland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sweden"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Switzerland"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Syria"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Taiwan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TJ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tajikistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tanzania"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thailand"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Timor-Leste"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Togo"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tokelau"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tonga"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Trinidad and Tobago"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tunisia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkey"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkmenistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turks and Caicos Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tuvalu"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uganda"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ukraine"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Arab Emirates"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Kingdom (UK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"US"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US) Minor Outlying Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States (US) Virgin Islands"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uruguay"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UZ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uzbekistan"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vanuatu"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vatican"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Venezuela"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vietnam"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wallis and Futuna"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Western Sahara"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Yemen"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zambia"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zimbabwe"</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/v2/settings/general/woocommerce_specific_ship_to_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_default_customer_address"</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">"Default customer location"</span><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">"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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"geolocation"</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="nl">""</span><span class="p">:</span><span class="w"> </span><span class="s2">"No location by default"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"base"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shop base address"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"geolocation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Geolocate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"geolocation_ajax"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Geolocate (with page caching support)"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This option determines a customers default location. The MaxMind GeoLite Database will be periodically downloaded to your wp-content directory if using geolocation."</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">"geolocation"</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/v2/settings/general/woocommerce_default_customer_address"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_calc_taxes"</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">"Enable taxes"</span><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 taxes and tax calculations"</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">"checkbox"</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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yes"</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/v2/settings/general/woocommerce_calc_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">"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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_demo_store"</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">"Store notice"</span><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 site-wide store notice text"</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">"checkbox"</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">"value"</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">"_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/v2/settings/general/woocommerce_demo_store"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_demo_store_notice"</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">"Store notice text"</span><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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"textarea"</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">"This is a demo store for testing purposes &mdash; no orders shall be fulfilled."</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">"This is a demo store for testing purposes &mdash; no orders shall be fulfilled."</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/v2/settings/general/woocommerce_demo_store_notice"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_currency"</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">"Currency"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls what currency prices are listed at in the catalog and which currency gateways will take payments in."</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GBP"</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="nl">"AED"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Arab Emirates dirham (&#x62f;.&#x625;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AFN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Afghan afghani (&#x60b;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ALL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Albanian lek (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Armenian dram (AMD)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ANG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Netherlands Antillean guilder (&fnof;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AOA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Angolan kwanza (Kz)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ARS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Argentine peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AUD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Australian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AWG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Aruban florin (&fnof;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AZN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Azerbaijani manat (AZN)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BAM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bosnia and Herzegovina convertible mark (KM)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BBD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Barbadian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BDT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bangladeshi taka (&#2547;&nbsp;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BGN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bulgarian lev (&#1083;&#1074;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BHD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahraini dinar (.&#x62f;.&#x628;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BIF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burundian franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bermudian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BND"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brunei dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BOB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bolivian boliviano (Bs.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BRL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brazilian real (&#82;&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BSD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahamian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BTC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bitcoin (&#3647;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BTN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bhutanese ngultrum (Nu.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BWP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Botswana pula (P)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BYR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belarusian ruble (Br)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BZD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belize dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CAD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Canadian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CDF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congolese franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CHF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swiss franc (&#67;&#72;&#70;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CLP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chilean peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CNY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chinese yuan (&yen;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"COP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Colombian peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CRC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Costa Rican col&oacute;n (&#x20a1;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CUC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuban convertible peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CUP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuban peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CVE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cape Verdean escudo (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CZK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Czech koruna (&#75;&#269;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DJF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Djiboutian franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DKK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Danish krone (DKK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DOP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominican peso (RD&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DZD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Algerian dinar (&#x62f;.&#x62c;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EGP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Egyptian pound (EGP)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ERN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Eritrean nakfa (Nfk)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ETB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ethiopian birr (Br)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EUR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Euro (&euro;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FJD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fijian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FKP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Falkland Islands pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GBP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pound sterling (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GEL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Georgian lari (&#x10da;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GGP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guernsey pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GHS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ghana cedi (&#x20b5;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GIP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gibraltar pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gambian dalasi (D)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GNF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinean franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GTQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guatemalan quetzal (Q)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GYD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guyanese dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HKD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hong Kong dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HNL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Honduran lempira (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HRK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Croatian kuna (Kn)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HTG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Haitian gourde (G)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HUF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hungarian forint (&#70;&#116;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IDR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indonesian rupiah (Rp)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ILS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Israeli new shekel (&#8362;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IMP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Manx pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"INR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indian rupee (&#8377;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IQD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iraqi dinar (&#x639;.&#x62f;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IRR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iranian rial (&#xfdfc;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IRT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iranian toman (&#x062A;&#x0648;&#x0645;&#x0627;&#x0646;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ISK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Icelandic kr&oacute;na (kr.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JEP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jersey pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jamaican dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JOD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jordanian dinar (&#x62f;.&#x627;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JPY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Japanese yen (&yen;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KES"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kenyan shilling (KSh)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KGS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kyrgyzstani som (&#x441;&#x43e;&#x43c;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KHR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cambodian riel (&#x17db;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KMF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Comorian franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KPW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"North Korean won (&#x20a9;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KRW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Korean won (&#8361;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KWD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kuwaiti dinar (&#x62f;.&#x643;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KYD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cayman Islands dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KZT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kazakhstani tenge (KZT)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LAK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lao kip (&#8365;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LBP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lebanese pound (&#x644;.&#x644;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LKR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sri Lankan rupee (&#xdbb;&#xdd4;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LRD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liberian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LSL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lesotho loti (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LYD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Libyan dinar (&#x644;.&#x62f;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MAD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moroccan dirham (&#x62f;.&#x645;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MDL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moldovan leu (MDL)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MGA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malagasy ariary (Ar)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MKD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macedonian denar (&#x434;&#x435;&#x43d;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MMK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burmese kyat (Ks)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MNT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mongolian t&ouml;gr&ouml;g (&#x20ae;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MOP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macanese pataca (P)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MRO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritanian ouguiya (UM)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MUR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritian rupee (&#x20a8;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MVR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maldivian rufiyaa (.&#x783;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MWK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malawian kwacha (MK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MXN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mexican peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MYR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malaysian ringgit (&#82;&#77;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MZN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozambican metical (MT)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NAD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Namibian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NGN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nigerian naira (&#8358;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NIO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nicaraguan c&oacute;rdoba (C&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NOK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norwegian krone (&#107;&#114;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NPR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nepalese rupee (&#8360;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NZD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Zealand dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"OMR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Omani rial (&#x631;.&#x639;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PAB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Panamanian balboa (B/.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PEN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Peruvian nuevo sol (S/.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PGK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Papua New Guinean kina (K)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PHP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Philippine peso (&#8369;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PKR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pakistani rupee (&#8360;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PLN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Polish z&#x142;oty (&#122;&#322;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PRB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Transnistrian ruble (&#x440;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PYG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Paraguayan guaran&iacute; (&#8370;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"QAR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qatari riyal (&#x631;.&#x642;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RON"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Romanian leu (lei)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RSD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Serbian dinar (&#x434;&#x438;&#x43d;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RUB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Russian ruble (&#8381;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RWF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rwandan franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SAR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saudi riyal (&#x631;.&#x633;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SBD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Solomon Islands dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SCR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Seychellois rupee (&#x20a8;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SDG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sudanese pound (&#x62c;.&#x633;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SEK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swedish krona (&#107;&#114;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SGD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Singapore dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SHP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Helena pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SLL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sierra Leonean leone (Le)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SOS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Somali shilling (Sh)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SRD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Surinamese dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SSP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Sudanese pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"STD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S&atilde;o Tom&eacute; and Pr&iacute;ncipe dobra (Db)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SYP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Syrian pound (&#x644;.&#x633;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SZL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swazi lilangeni (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"THB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thai baht (&#3647;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TJS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tajikistani somoni (&#x405;&#x41c;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TMT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkmenistan manat (m)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TND"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tunisian dinar (&#x62f;.&#x62a;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TOP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tongan pa&#x2bb;anga (T&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TRY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkish lira (&#8378;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TTD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Trinidad and Tobago dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TWD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Taiwan dollar (&#78;&#84;&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TZS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tanzanian shilling (Sh)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UAH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ukrainian hryvnia (&#8372;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UGX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ugandan shilling (UGX)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"USD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UYU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uruguayan peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UZS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uzbekistani som (UZS)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VEF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Venezuelan bol&iacute;var (Bs F)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VND"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vietnamese &#x111;&#x1ed3;ng (&#8363;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VUV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vanuatu vatu (Vt)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WST"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Samoan t&#x101;l&#x101; (T)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XAF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Central African CFA franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XCD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"East Caribbean dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XOF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"West African CFA franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XPF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CFP franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YER"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Yemeni rial (&#xfdfc;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZAR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South African rand (&#82;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZMW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zambian kwacha (ZK)"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls what currency prices are listed at in the catalog and which currency gateways will take payments in."</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">"USD"</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/v2/settings/general/woocommerce_currency"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_currency_pos"</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">"Currency position"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the position of the currency symbol."</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"left"</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="nl">"left"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Left (&#36;99.99)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"right"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Right (99.99&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"left_space"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Left with space (&#36; 99.99)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"right_space"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Right with space (99.99 &#36;)"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the position of the currency symbol."</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">"left"</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/v2/settings/general/woocommerce_currency_pos"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_price_thousand_sep"</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">"Thousand separator"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This sets the thousand separator of displayed prices."</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">"text"</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">","</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This sets the thousand separator of displayed prices."</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">","</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/v2/settings/general/woocommerce_price_thousand_sep"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_price_decimal_sep"</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">"Decimal separator"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This sets the decimal separator of displayed prices."</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">"text"</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">"."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This sets the decimal separator of displayed prices."</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">"."</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/v2/settings/general/woocommerce_price_decimal_sep"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_price_num_decimals"</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">"Number of decimals"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This sets the number of decimal points shown in displayed prices."</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">"number"</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">"2"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This sets the number of decimal points shown in displayed prices."</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">"2"</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/v2/settings/general/woocommerce_price_num_decimals"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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-setting-option'>Update a setting option</h2>
|
|
<p>This API lets you make changes to a setting option.</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/v2/settings/<group_id>/<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/v2/settings/general/woocommerce_allowed_countries <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">'{
|
|
"value": "all_except"
|
|
}'</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">value</span><span class="p">:</span> <span class="dl">"</span><span class="s2">all_except</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">settings/general/woocommerce_allowed_countries</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">'value'</span> <span class="o">=></span> <span class="s1">'all_except'</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">'settings/general/woocommerce_allowed_countries'</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">"value"</span><span class="p">:</span> <span class="s">"all_except"</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">"settings/general/woocommerce_allowed_countries"</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">value: </span><span class="s2">"all_except"</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">"settings/general/woocommerce_allowed_countries"</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="s2">"woocommerce_allowed_countries"</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">"Selling location(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">"This option lets you limit which countries you are willing to sell to."</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">"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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"all"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"all_except"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries, except for&hellip;"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"specific"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to specific countries"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This option lets you limit which countries you are willing to sell to."</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">"all_except"</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/v2/settings/general/woocommerce_allowed_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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='batch-update-setting-options'>Batch update setting options</h2>
|
|
<p>This API helps you to batch update multiple setting options.</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/v2/settings/<id>/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/v2/settings/general/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">'{
|
|
"update": [
|
|
{
|
|
"id": "woocommerce_allowed_countries",
|
|
"value": "all"
|
|
},
|
|
{
|
|
"id": "woocommerce_demo_store",
|
|
"value": "yes"
|
|
},
|
|
{
|
|
"id": "woocommerce_currency",
|
|
"value": "GBP"
|
|
}
|
|
]
|
|
}'</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">regular_price</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="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">Blue</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">10.00</span><span class="dl">"</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">White</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">733</span><span class="p">,</span>
|
|
<span class="na">regular_price</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="na">delete</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="mi">732</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/22/settings/general/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">'regular_price'</span> <span class="o">=></span> <span class="s1">'10.00'</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">'Blue'</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">'10.00'</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">'White'</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">733</span><span class="p">,</span>
|
|
<span class="s1">'regular_price'</span> <span class="o">=></span> <span class="s1">'10.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">732</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/22/settings/general/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">"regular_price"</span><span class="p">:</span> <span class="s">"10.00"</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">"Blue"</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">"10.00"</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">"White"</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">733</span><span class="p">,</span>
|
|
<span class="s">"regular_price"</span><span class="p">:</span> <span class="s">"10.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">732</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/22/settings/general/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">regular_price: </span><span class="s2">"10.00"</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">"Blue"</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">"10.00"</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">"White"</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">733</span><span class="p">,</span>
|
|
<span class="ss">regular_price: </span><span class="s2">"10.00"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="ss">delete: </span><span class="p">[</span>
|
|
<span class="mi">732</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/22/settings/general/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">"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="s2">"woocommerce_allowed_countries"</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">"Selling location(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">"This option lets you limit which countries you are willing to sell to."</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">"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">"options"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"all"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"all_except"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to all countries, except for&hellip;"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"specific"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sell to specific countries"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This option lets you limit which countries you are willing to sell to."</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">"all"</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/v2/settings/general/woocommerce_allowed_countries"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_demo_store"</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">"Store notice"</span><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 site-wide store notice text"</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">"checkbox"</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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yes"</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/v2/settings/general/woocommerce_demo_store"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"woocommerce_currency"</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">"Currency"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls what currency prices are listed at in the catalog and which currency gateways will take payments in."</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">"default"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GBP"</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="nl">"AED"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United Arab Emirates dirham (&#x62f;.&#x625;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AFN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Afghan afghani (&#x60b;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ALL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Albanian lek (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Armenian dram (AMD)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ANG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Netherlands Antillean guilder (&fnof;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AOA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Angolan kwanza (Kz)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ARS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Argentine peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AUD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Australian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AWG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Aruban florin (&fnof;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"AZN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Azerbaijani manat (AZN)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BAM"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bosnia and Herzegovina convertible mark (KM)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BBD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Barbadian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BDT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bangladeshi taka (&#2547;&nbsp;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BGN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bulgarian lev (&#1083;&#1074;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BHD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahraini dinar (.&#x62f;.&#x628;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BIF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burundian franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bermudian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BND"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brunei dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BOB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bolivian boliviano (Bs.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BRL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brazilian real (&#82;&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BSD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bahamian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BTC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bitcoin (&#3647;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BTN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Bhutanese ngultrum (Nu.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BWP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Botswana pula (P)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BYR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belarusian ruble (Br)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"BZD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Belize dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CAD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Canadian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CDF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Congolese franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CHF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swiss franc (&#67;&#72;&#70;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CLP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chilean peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CNY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Chinese yuan (&yen;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"COP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Colombian peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CRC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Costa Rican col&oacute;n (&#x20a1;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CUC"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuban convertible peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CUP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cuban peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CVE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cape Verdean escudo (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"CZK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Czech koruna (&#75;&#269;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DJF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Djiboutian franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DKK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Danish krone (DKK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DOP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dominican peso (RD&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"DZD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Algerian dinar (&#x62f;.&#x62c;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EGP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Egyptian pound (EGP)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ERN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Eritrean nakfa (Nfk)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ETB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ethiopian birr (Br)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"EUR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Euro (&euro;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FJD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fijian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"FKP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Falkland Islands pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GBP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pound sterling (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GEL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Georgian lari (&#x10da;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GGP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guernsey pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GHS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ghana cedi (&#x20b5;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GIP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gibraltar pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gambian dalasi (D)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GNF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guinean franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GTQ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guatemalan quetzal (Q)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"GYD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Guyanese dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HKD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hong Kong dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HNL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Honduran lempira (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HRK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Croatian kuna (Kn)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HTG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Haitian gourde (G)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"HUF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hungarian forint (&#70;&#116;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IDR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indonesian rupiah (Rp)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ILS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Israeli new shekel (&#8362;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IMP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Manx pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"INR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Indian rupee (&#8377;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IQD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iraqi dinar (&#x639;.&#x62f;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IRR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iranian rial (&#xfdfc;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"IRT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iranian toman (&#x062A;&#x0648;&#x0645;&#x0627;&#x0646;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ISK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Icelandic kr&oacute;na (kr.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JEP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jersey pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JMD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jamaican dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JOD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jordanian dinar (&#x62f;.&#x627;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"JPY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Japanese yen (&yen;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KES"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kenyan shilling (KSh)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KGS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kyrgyzstani som (&#x441;&#x43e;&#x43c;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KHR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cambodian riel (&#x17db;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KMF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Comorian franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KPW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"North Korean won (&#x20a9;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KRW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Korean won (&#8361;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KWD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kuwaiti dinar (&#x62f;.&#x643;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KYD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cayman Islands dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"KZT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Kazakhstani tenge (KZT)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LAK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lao kip (&#8365;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LBP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lebanese pound (&#x644;.&#x644;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LKR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sri Lankan rupee (&#xdbb;&#xdd4;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LRD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Liberian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LSL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lesotho loti (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"LYD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Libyan dinar (&#x644;.&#x62f;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MAD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moroccan dirham (&#x62f;.&#x645;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MDL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Moldovan leu (MDL)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MGA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malagasy ariary (Ar)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MKD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macedonian denar (&#x434;&#x435;&#x43d;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MMK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Burmese kyat (Ks)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MNT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mongolian t&ouml;gr&ouml;g (&#x20ae;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MOP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Macanese pataca (P)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MRO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritanian ouguiya (UM)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MUR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mauritian rupee (&#x20a8;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MVR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Maldivian rufiyaa (.&#x783;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MWK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malawian kwacha (MK)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MXN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mexican peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MYR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Malaysian ringgit (&#82;&#77;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"MZN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Mozambican metical (MT)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NAD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Namibian dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NGN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nigerian naira (&#8358;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NIO"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nicaraguan c&oacute;rdoba (C&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NOK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Norwegian krone (&#107;&#114;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NPR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Nepalese rupee (&#8360;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"NZD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Zealand dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"OMR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Omani rial (&#x631;.&#x639;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PAB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Panamanian balboa (B/.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PEN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Peruvian nuevo sol (S/.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PGK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Papua New Guinean kina (K)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PHP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Philippine peso (&#8369;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PKR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pakistani rupee (&#8360;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PLN"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Polish z&#x142;oty (&#122;&#322;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PRB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Transnistrian ruble (&#x440;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"PYG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Paraguayan guaran&iacute; (&#8370;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"QAR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Qatari riyal (&#x631;.&#x642;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RON"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Romanian leu (lei)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RSD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Serbian dinar (&#x434;&#x438;&#x43d;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RUB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Russian ruble (&#8381;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"RWF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rwandan franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SAR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saudi riyal (&#x631;.&#x633;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SBD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Solomon Islands dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SCR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Seychellois rupee (&#x20a8;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SDG"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sudanese pound (&#x62c;.&#x633;.)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SEK"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swedish krona (&#107;&#114;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SGD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Singapore dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SHP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Saint Helena pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SLL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Sierra Leonean leone (Le)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SOS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Somali shilling (Sh)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SRD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Surinamese dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SSP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South Sudanese pound (&pound;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"STD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"S&atilde;o Tom&eacute; and Pr&iacute;ncipe dobra (Db)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SYP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Syrian pound (&#x644;.&#x633;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"SZL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Swazi lilangeni (L)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"THB"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Thai baht (&#3647;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TJS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tajikistani somoni (&#x405;&#x41c;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TMT"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkmenistan manat (m)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TND"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tunisian dinar (&#x62f;.&#x62a;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TOP"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tongan pa&#x2bb;anga (T&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TRY"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Turkish lira (&#8378;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TTD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Trinidad and Tobago dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TWD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"New Taiwan dollar (&#78;&#84;&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"TZS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tanzanian shilling (Sh)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UAH"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ukrainian hryvnia (&#8372;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UGX"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ugandan shilling (UGX)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"USD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"United States dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UYU"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uruguayan peso (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"UZS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Uzbekistani som (UZS)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VEF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Venezuelan bol&iacute;var (Bs F)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VND"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vietnamese &#x111;&#x1ed3;ng (&#8363;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"VUV"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Vanuatu vatu (Vt)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"WST"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Samoan t&#x101;l&#x101; (T)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XAF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Central African CFA franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XCD"</span><span class="p">:</span><span class="w"> </span><span class="s2">"East Caribbean dollar (&#36;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XOF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"West African CFA franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"XPF"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CFP franc (Fr)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"YER"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Yemeni rial (&#xfdfc;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZAR"</span><span class="p">:</span><span class="w"> </span><span class="s2">"South African rand (&#82;)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"ZMW"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Zambian kwacha (ZK)"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls what currency prices are listed at in the catalog and which currency gateways will take payments in."</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">"GBP"</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/v2/settings/general/woocommerce_currency"</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/v2/settings/general"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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='payment-gateways'>Payment gateways</h1>
|
|
<p>The payment gateways API allows you to view, and update individual payment gateways. Results are not paginated - all gateways will be returned.</p>
|
|
<h2 id='payment-gateway-properties'>Payment gateway properties</h2>
|
|
<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>Payment gateway ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Payment gateway title on checkout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Payment gateway description on checkout.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>integer</td>
|
|
<td>Payment gateway sort order.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Payment gateway enabled status.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_title</code></td>
|
|
<td>string</td>
|
|
<td>Payment gateway method title. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_description</code></td>
|
|
<td>string</td>
|
|
<td>Payment gateway method description. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>settings</code></td>
|
|
<td>object</td>
|
|
<td>Payment gateway settings. See <a href="#payment-gateway-settings-properties">Payment gateway - Settings properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='payment-gateway-settings-properties'>Payment gateway - Settings 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>A unique identifier for the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>label</code></td>
|
|
<td>string</td>
|
|
<td>A human readable label for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>A human readable description for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Type of setting. Options: <code>text</code>, <code>email</code>, <code>number</code>, <code>color</code>, <code>password</code>, <code>textarea</code>, <code>select</code>, <code>multiselect</code>, <code>radio</code>, <code>image_width</code> and <code>checkbox</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Setting value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default</code></td>
|
|
<td>string</td>
|
|
<td>Default value for the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tip</code></td>
|
|
<td>string</td>
|
|
<td>Additional help text shown to the user about the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>placeholder</code></td>
|
|
<td>string</td>
|
|
<td>Placeholder text to be displayed in text inputs. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='retrieve-a-payment-gateway'>Retrieve a payment gateway</h2>
|
|
<p>This API lets you retrieve and view a specific payment gateway.</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/v2/payment_gateways/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/payment_gateways/bacs <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">payment_gateways/bacs</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">'payment_gateways/bacs'</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">"payment_gateways/bacs"</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">"payment_gateways/bacs"</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="s2">"bacs"</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">"Direct bank transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order won't be shipped until the funds have cleared in our account."</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"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">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allows payments by BACS, more commonly known as direct bank/wire transfer."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Direct bank transfer"</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">"Direct bank transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"instructions"</span><span class="p">:</span><span class="w"> </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">"instructions"</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">"Instructions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</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">"textarea"</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">"Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order won't be shipped until the funds have cleared in our account."</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"_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/v2/payment_gateways/bacs"</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/v2/payment_gateways"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-payment-gateways'>List all payment gateways</h2>
|
|
<p>This API helps you to view all the payment gateways.</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/v2/payment_gateways</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/payment_gateways <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">payment_gateways</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">'payment_gateways'</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">"payment_gateways"</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">"payment_gateways"</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="s2">"bacs"</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">"Direct bank transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order won't be shipped until the funds have cleared in our account."</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"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">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allows payments by BACS, more commonly known as direct bank/wire transfer."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Direct bank transfer"</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">"Direct bank transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"instructions"</span><span class="p">:</span><span class="w"> </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">"instructions"</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">"Instructions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</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">"textarea"</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">"Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order won't be shipped until the funds have cleared in our account."</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"_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/v2/payment_gateways/bacs"</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/v2/payment_gateways"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"cheque"</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">"Check payments"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Please send a check to Store Name, Store Street, Store Town, Store State / County, Store Postcode."</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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"Check payments"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allows check payments. Why would you take checks in this day and age? Well you probably wouldn't but it does allow you to make test purchases for testing order emails and the 'success' pages etc."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Check payments"</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">"Check payments"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"instructions"</span><span class="p">:</span><span class="w"> </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">"instructions"</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">"Instructions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</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">"textarea"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"_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/v2/payment_gateways/cheque"</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/v2/payment_gateways"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"cod"</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">"Cash on delivery"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pay with cash upon delivery."</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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"Cash on delivery"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Have your customers pay with cash (or by other means) upon delivery."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><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 description that the customer will see on your checkout."</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">"text"</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">"Cash on delivery"</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">"Cash on delivery"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Payment method description that the customer will see on your checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"instructions"</span><span class="p">:</span><span class="w"> </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">"instructions"</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">"Instructions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page."</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">"textarea"</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">""</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">"Pay with cash upon delivery."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"enable_for_methods"</span><span class="p">:</span><span class="w"> </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">"enable_for_methods"</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">"Enable for shipping methods"</span><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 COD is only available for certain methods, set it up here. Leave blank to enable for all methods."</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">"multiselect"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If COD is only available for certain methods, set it up here. Leave blank to enable for all methods."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"flat_rate"</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">"free_shipping"</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">"local_pickup"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Local pickup"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"enable_for_virtual"</span><span class="p">:</span><span class="w"> </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">"enable_for_virtual"</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">"Accept COD if the order is virtual"</span><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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"checkbox"</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">"yes"</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">"yes"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"_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/v2/payment_gateways/cod"</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/v2/payment_gateways"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"paypal"</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">"PayPal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pay via PayPal; you can pay with your credit card if you don't have a PayPal account."</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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal Standard sends customers to PayPal to enter their payment information. PayPal IPN requires fsockopen/cURL support to update order statuses after payment. Check the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-status</span><span class="se">\"</span><span class="s2">>system status</a> page for more details."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"PayPal"</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">"PayPal"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"email"</span><span class="p">:</span><span class="w"> </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">"email"</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">"PayPal email"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Please enter your PayPal email address; this is needed in order to take payment."</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">"email"</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">"me@example.com"</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">"me@example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Please enter your PayPal email address; this is needed in order to take payment."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"you@youremail.com"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"testmode"</span><span class="p">:</span><span class="w"> </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">"testmode"</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">"Enable PayPal sandbox"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal sandbox can be used to test payments. Sign up for a <a href=</span><span class="se">\"</span><span class="s2">https://developer.paypal.com/</span><span class="se">\"</span><span class="s2">>developer account</a>."</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">"checkbox"</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">"yes"</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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal sandbox can be used to test payments. Sign up for a <a href=</span><span class="se">\"</span><span class="s2">https://developer.paypal.com/</span><span class="se">\"</span><span class="s2">>developer account</a>."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"debug"</span><span class="p">:</span><span class="w"> </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">"debug"</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">"Enable logging"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Log PayPal events, such as IPN requests, inside <code>/var/www/woocommerce/wp-content/uploads/wc-logs/paypal-de01f7c6894774e7ac8e4207bb8bac2f.log</code>"</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">"checkbox"</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">"yes"</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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Log PayPal events, such as IPN requests, inside <code>/var/www/woocommerce/wp-content/uploads/wc-logs/paypal-de01f7c6894774e7ac8e4207bb8bac2f.log</code>"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"receiver_email"</span><span class="p">:</span><span class="w"> </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">"receiver_email"</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">"Receiver email"</span><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 your main PayPal email differs from the PayPal email entered above, input your main receiver email for your PayPal account here. This is used to validate IPN requests."</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">"email"</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">"me@example.com"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"If your main PayPal email differs from the PayPal email entered above, input your main receiver email for your PayPal account here. This is used to validate IPN requests."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"you@youremail.com"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"identity_token"</span><span class="p">:</span><span class="w"> </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">"identity_token"</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">"PayPal identity token"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optionally enable </span><span class="se">\"</span><span class="s2">Payment Data Transfer</span><span class="se">\"</span><span class="s2"> (Profile > Profile and Settings > My Selling Tools > Website Preferences) and then copy your identity token here. This will allow payments to be verified without the need for PayPal IPN."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optionally enable </span><span class="se">\"</span><span class="s2">Payment Data Transfer</span><span class="se">\"</span><span class="s2"> (Profile > Profile and Settings > My Selling Tools > Website Preferences) and then copy your identity token here. This will allow payments to be verified without the need for PayPal IPN."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"invoice_prefix"</span><span class="p">:</span><span class="w"> </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">"invoice_prefix"</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">"Invoice prefix"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Please enter a prefix for your invoice numbers. If you use your PayPal account for multiple stores ensure this prefix is unique as PayPal will not allow orders with the same invoice number."</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">"text"</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">"WC-"</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-"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Please enter a prefix for your invoice numbers. If you use your PayPal account for multiple stores ensure this prefix is unique as PayPal will not allow orders with the same invoice number."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"send_shipping"</span><span class="p">:</span><span class="w"> </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">"send_shipping"</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">"Send shipping details to PayPal instead of billing."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal allows us to send one address. If you are using PayPal for shipping labels you may prefer to send the shipping address rather than billing."</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">"checkbox"</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">"no"</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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal allows us to send one address. If you are using PayPal for shipping labels you may prefer to send the shipping address rather than billing."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"address_override"</span><span class="p">:</span><span class="w"> </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">"address_override"</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">"Enable </span><span class="se">\"</span><span class="s2">address_override</span><span class="se">\"</span><span class="s2"> to prevent address information from being changed."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal verifies addresses therefore this setting can cause errors (we recommend keeping it disabled)."</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">"checkbox"</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">"no"</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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayPal verifies addresses therefore this setting can cause errors (we recommend keeping it disabled)."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"paymentaction"</span><span class="p">:</span><span class="w"> </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">"paymentaction"</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">"Payment action"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Choose whether you wish to capture funds immediately or authorize payment only."</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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sale"</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">"sale"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Choose whether you wish to capture funds immediately or authorize payment only."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"sale"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Capture"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"authorization"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Authorize"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"page_style"</span><span class="p">:</span><span class="w"> </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">"page_style"</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">"Page style"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optionally enter the name of the page style you wish to use. These are defined within your PayPal account. This affects classic PayPal checkout screens."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optionally enter the name of the page style you wish to use. These are defined within your PayPal account. This affects classic PayPal checkout screens."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"image_url"</span><span class="p">:</span><span class="w"> </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">"image_url"</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">"Image url"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optionally enter the URL to a 150x50px image displayed as your logo in the upper left corner of the PayPal checkout pages."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optionally enter the URL to a 150x50px image displayed as your logo in the upper left corner of the PayPal checkout pages."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"api_username"</span><span class="p">:</span><span class="w"> </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">"api_username"</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">"API username"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get your API credentials from PayPal."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get your API credentials from PayPal."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"api_password"</span><span class="p">:</span><span class="w"> </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">"api_password"</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">"API password"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get your API credentials from PayPal."</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">"password"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get your API credentials from PayPal."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"api_signature"</span><span class="p">:</span><span class="w"> </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">"api_signature"</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">"API signature"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get your API credentials from PayPal."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get your API credentials from PayPal."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Optional"</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/v2/payment_gateways/paypal"</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/v2/payment_gateways"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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-payment-gateway'>Update a payment gateway</h2>
|
|
<p>This API lets you make changes to a payment gateway.</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/v2/payment_gateways/<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/v2/payment_gateways/bacs <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">'{
|
|
"enabled": 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">enabled</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">put</span><span class="p">(</span><span class="dl">"</span><span class="s2">payment_gateways/bacs</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">'enabled'</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">put</span><span class="p">(</span><span class="s1">'payment_gateways/bacs'</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">"enabled"</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">put</span><span class="p">(</span><span class="s">"payment_gateways/bacs"</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">enabled: </span><span class="kp">true</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">"payment_gateways/bacs"</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="s2">"bacs"</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">"Direct bank transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order won't be shipped until the funds have cleared in our account."</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">0</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"BACS"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Allows payments by BACS, more commonly known as direct bank/wire transfer."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Direct bank transfer"</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">"Direct bank transfer"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"instructions"</span><span class="p">:</span><span class="w"> </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">"instructions"</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">"Instructions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</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">"textarea"</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">"Make your payment directly into our bank account. Please use your Order ID as the payment reference. Your order won't be shipped until the funds have cleared in our account."</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Instructions that will be added to the thank you page and emails."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"_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/v2/payment_gateways/bacs"</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/v2/payment_gateways"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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='shipping-zones'>Shipping zones</h1>
|
|
<p>The shipping zones API allows you to create, view, update, and delete individual shipping zones.</p>
|
|
<h2 id='shipping-zone-properties'>Shipping zone 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 zone name. <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>integer</td>
|
|
<td>Shipping zone order.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='create-a-shipping-zone'>Create a shipping zone</h2>
|
|
<p>This API helps you to create a new shipping zone.</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/v2/shipping/zones</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>JSON response example:</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/v2/shipping/zones <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": "Brazil"
|
|
}'</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">Brazil</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">shipping/zones</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">'Brazil'</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">'shipping/zones'</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">"Brazil"</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">"shipping/zones"</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">"Brazil"</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">"shipping/zones"</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">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">"Brazil"</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">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/v2/shipping/zones/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/v2/shipping/zones"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describedby"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-zone'>Retrieve a shipping zone</h2>
|
|
<p>This API lets you retrieve and view a specific shipping zone 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/v2/shipping/zones/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping/zones/5 <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">shipping/zones/5</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">'shipping/zones/5'</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">"shipping/zones/5"</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">"shipping/zones/5"</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">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">"Brazil"</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">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/v2/shipping/zones/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/v2/shipping/zones"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describedby"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-zones'>List all shipping zones</h2>
|
|
<p>This API helps you to view all the shipping zones.</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/v2/shipping/zones</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping/zones <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">shipping/zones</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">'shipping/zones'</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">"shipping/zones"</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">"shipping/zones"</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">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">"Rest of the World"</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">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/v2/shipping/zones/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">"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/v2/shipping/zones"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describedby"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/0/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Brazil"</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">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/v2/shipping/zones/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/v2/shipping/zones"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describedby"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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-shipping-zone'>Update a shipping zone</h2>
|
|
<p>This API lets you make changes to a shipping zone.</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/v2/shipping/zones/<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/v2/shipping/zones/5 <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": 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">order</span><span class="p">:</span> <span class="mi">1</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">shipping/zones/5</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'</span> <span class="o">=></span> <span class="mi">1</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">'shipping/zones/5'</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"</span><span class="p">:</span> <span class="mi">1</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">"shipping/zones/5"</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: </span><span class="mi">1</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">"shipping/zones/5"</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">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">"Brazil"</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">"_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/v2/shipping/zones/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/v2/shipping/zones"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describedby"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-zone'>Delete a shipping zone</h2>
|
|
<p>This API helps you delete a shipping zone.</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/v2/shipping/zones/<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/v2/shipping/zones/5?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">shipping/zones/5</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">'shipping/zones/5'</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">"shipping/zones/5"</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">"shipping/zones/5"</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">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">"Brazil"</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">"_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/v2/shipping/zones/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/v2/shipping/zones"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describedby"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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='shipping-zone-locations'>Shipping zone locations</h1>
|
|
<p>The shipping zone locations API allows you to view and batch update locations of a shipping zone.</p>
|
|
<h2 id='shipping-location-properties'>Shipping location properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>code</code></td>
|
|
<td>string</td>
|
|
<td>Shipping zone location code.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Shipping zone location type. Options: <code>postcode</code>, <code>state</code>, <code>country</code> and <code>continent</code>. Default is <code>country</code>.</td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='list-all-locations-of-a-shipping-zone'>List all locations of a shipping zone</h2>
|
|
<p>This API helps you to view all the locations of a shipping zone.</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/v2/shipping/zones/<id>/locations</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping/zones/5/locations <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">shipping/zones/5/locations</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">'shipping/zones/5/locations'</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">"shipping/zones/5/locations"</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">"shipping/zones/5/locations"</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">"code"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"country"</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/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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-locations-of-a-shipping-zone'>Update a locations of a shipping zone</h2>
|
|
<p>This API lets you make changes to locations of a shipping zone.</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/v2/shipping/zones/<id>/locations</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/v2/shipping/zones/5/locations <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": "BR:SP",
|
|
"type": "state"
|
|
},
|
|
{
|
|
"code": "BR:RJ",
|
|
"type": "state"
|
|
}
|
|
]'</span>
|
|
</code></pre></div><div class="highlight"><pre class="highlight javascript tab-javascript"><code><span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="na">code</span><span class="p">:</span> <span class="dl">'</span><span class="s1">BR:SP</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">state</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="s1">BR:RJ</span><span class="dl">'</span><span class="p">,</span>
|
|
<span class="na">type</span><span class="p">:</span> <span class="dl">'</span><span class="s1">state</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">shipping/zones/5/locations</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="p">[</span>
|
|
<span class="s1">'code'</span> <span class="o">=></span> <span class="s1">'BR:SP'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'state'</span>
|
|
<span class="p">],</span>
|
|
<span class="p">[</span>
|
|
<span class="s1">'code'</span> <span class="o">=></span> <span class="s1">'BR:RJ'</span><span class="p">,</span>
|
|
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'state'</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">'shipping/zones/5/locations'</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="p">{</span>
|
|
<span class="s">"code"</span><span class="p">:</span> <span class="s">"BR:SP"</span><span class="p">,</span>
|
|
<span class="s">"type"</span><span class="p">:</span> <span class="s">"state"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="s">"code"</span><span class="p">:</span> <span class="s">"BR:RJ"</span><span class="p">,</span>
|
|
<span class="s">"type"</span><span class="p">:</span> <span class="s">"state"</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">"shipping/zones/5/locations"</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="p">{</span>
|
|
<span class="ss">code: </span><span class="s2">"BR:SP"</span><span class="p">,</span>
|
|
<span class="ss">type: </span><span class="s2">"state"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="ss">code: </span><span class="s2">"BR:RJ"</span><span class="p">,</span>
|
|
<span class="ss">type: </span><span class="s2">"state"</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">"shipping/zones/5/locations"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BR:SP"</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">"state"</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/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BR:RJ"</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">"state"</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/v2/shipping/zones/5/locations"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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='shipping-zone-methods'>Shipping zone methods</h1>
|
|
<p>The shipping zone methods API allows you to create, view, update, and delete individual methods of a shipping zone.</p>
|
|
<h2 id='shipping-method-properties'>Shipping method properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>instance_id</code></td>
|
|
<td>integer</td>
|
|
<td>Shipping method instance ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method customer facing title. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>order</code></td>
|
|
<td>integer</td>
|
|
<td>Shipping method sort order.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Shipping method enabled status.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_id</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method ID. <i class="label label-info">read-only</i> <i class="label label-info">mandatory</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_title</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method title. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>method_description</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method description. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>settings</code></td>
|
|
<td>object</td>
|
|
<td>Shipping method settings. See <a href="#shipping-method-settings-properties">Shipping method - Settings properties</a></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='shipping-method-settings-properties'>Shipping method - Settings 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>A unique identifier for the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>label</code></td>
|
|
<td>string</td>
|
|
<td>A human readable label for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>A human readable description for the setting used in interfaces. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>type</code></td>
|
|
<td>string</td>
|
|
<td>Type of setting. Options: <code>text</code>, <code>email</code>, <code>number</code>, <code>color</code>, <code>password</code>, <code>textarea</code>, <code>select</code>, <code>multiselect</code>, <code>radio</code>, <code>image_width</code> and <code>checkbox</code>. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>string</td>
|
|
<td>Setting value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default</code></td>
|
|
<td>string</td>
|
|
<td>Default value for the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tip</code></td>
|
|
<td>string</td>
|
|
<td>Additional help text shown to the user about the setting. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>placeholder</code></td>
|
|
<td>string</td>
|
|
<td>Placeholder text to be displayed in text inputs. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='include-a-shipping-method-to-a-shipping-zone'>Include a shipping method to a shipping zone</h2>
|
|
<p>This API helps you to create a new shipping method to a shipping zone.</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/v2/shipping/zones/<id>/methods</h6>
|
|
</div>
|
|
</div>
|
|
|
|
<blockquote>
|
|
<p>JSON response example:</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/v2/shipping/zones/5/methods <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">'{
|
|
"method_id": "flat_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">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="nx">WooCommerce</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="dl">"</span><span class="s2">shipping/zones/5/methods</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">'method_id'</span> <span class="o">=></span> <span class="s1">'flat_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">'shipping/zones/5/methods'</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">"method_id"</span><span class="p">:</span> <span class="s">"flat_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">"shipping/zones/5/methods"</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">method_id: </span><span class="s2">"flat_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">"shipping/zones/5/methods"</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">"instance_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">"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">"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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Lets you charge a fixed rate for shipping.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Method title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Flat rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"tax_status"</span><span class="p">:</span><span class="w"> </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">"tax_status"</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">"Tax status"</span><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">"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">"value"</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">"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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"taxable"</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">"none"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"cost"</span><span class="p">:</span><span class="w"> </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">"cost"</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">"Cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">"0"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_costs"</span><span class="p">:</span><span class="w"> </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">"class_costs"</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">"Shipping class costs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</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">"title"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_cost_92"</span><span class="p">:</span><span class="w"> </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">"class_cost_92"</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">"</span><span class="se">\"</span><span class="s2">Express</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class_cost_91"</span><span class="p">:</span><span class="w"> </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">"class_cost_91"</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">"</span><span class="se">\"</span><span class="s2">Priority</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"no_class_cost"</span><span class="p">:</span><span class="w"> </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">"no_class_cost"</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">"No shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"type"</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">"Calculation type"</span><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">"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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"class"</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">"class"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per class: Charge shipping for each shipping class individually"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per order: Charge shipping for the most expensive shipping 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="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/v2/shipping/zones/5/methods/26"</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/v2/shipping/zones/5/methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-method-from-a-shipping-zone'>Retrieve a shipping method from a shipping zone</h2>
|
|
<p>This API lets you retrieve and view a specific shipping method from a shipping zone 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/v2/shipping/zones/<zone_id>/methods/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping/zones/5/methods/26 <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">shipping/zones/5/methods/26</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">'shipping/zones/5/methods/26'</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">"shipping/zones/5/methods/26"</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">"shipping/zones/5/methods/26"</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">"instance_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">"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">"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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Lets you charge a fixed rate for shipping.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Method title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Flat rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"tax_status"</span><span class="p">:</span><span class="w"> </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">"tax_status"</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">"Tax status"</span><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">"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">"value"</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">"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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"taxable"</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">"none"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"cost"</span><span class="p">:</span><span class="w"> </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">"cost"</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">"Cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">"0"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_costs"</span><span class="p">:</span><span class="w"> </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">"class_costs"</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">"Shipping class costs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</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">"title"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_cost_92"</span><span class="p">:</span><span class="w"> </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">"class_cost_92"</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">"</span><span class="se">\"</span><span class="s2">Express</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class_cost_91"</span><span class="p">:</span><span class="w"> </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">"class_cost_91"</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">"</span><span class="se">\"</span><span class="s2">Priority</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"no_class_cost"</span><span class="p">:</span><span class="w"> </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">"no_class_cost"</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">"No shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"type"</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">"Calculation type"</span><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">"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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"class"</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">"class"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per class: Charge shipping for each shipping class individually"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per order: Charge shipping for the most expensive shipping 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="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/v2/shipping/zones/5/methods/26"</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/v2/shipping/zones/5/methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-methods-from-a-shipping-zone'>List all shipping methods from a shipping zone</h2>
|
|
<p>This API helps you to view all the shipping methods from a shipping zone.</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/v2/shipping/zones/<id>/methods</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping/zones/5/methods <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">shipping/zones/5/methods</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">'shipping/zones/5/methods'</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">"shipping/zones/5/methods"</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">"shipping/zones/5/methods"</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">"instance_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">"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">"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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Lets you charge a fixed rate for shipping.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Method title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Flat rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"tax_status"</span><span class="p">:</span><span class="w"> </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">"tax_status"</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">"Tax status"</span><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">"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">"value"</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">"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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"taxable"</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">"none"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"cost"</span><span class="p">:</span><span class="w"> </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">"cost"</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">"Cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">"0"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_costs"</span><span class="p">:</span><span class="w"> </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">"class_costs"</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">"Shipping class costs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</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">"title"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_cost_92"</span><span class="p">:</span><span class="w"> </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">"class_cost_92"</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">"</span><span class="se">\"</span><span class="s2">Express</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class_cost_91"</span><span class="p">:</span><span class="w"> </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">"class_cost_91"</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">"</span><span class="se">\"</span><span class="s2">Priority</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"no_class_cost"</span><span class="p">:</span><span class="w"> </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">"no_class_cost"</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">"No shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"type"</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">"Calculation type"</span><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">"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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"class"</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">"class"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per class: Charge shipping for each shipping class individually"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per order: Charge shipping for the most expensive shipping 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="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/v2/shipping/zones/5/methods/26"</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/v2/shipping/zones/5/methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"instance_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">"title"</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">"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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</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">"method_title"</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">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Free shipping is a special method which can be triggered with coupons and minimum spends.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Free shipping"</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">"Free shipping"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"requires"</span><span class="p">:</span><span class="w"> </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">"requires"</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">"Free shipping requires..."</span><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">"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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">""</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"coupon"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A valid free shipping coupon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"min_amount"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A minimum order amount"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"either"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A minimum order amount OR a coupon"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"both"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A minimum order amount AND a coupon"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"min_amount"</span><span class="p">:</span><span class="w"> </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">"min_amount"</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">"Minimum order amount"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Users will need to spend this amount to get free shipping (if enabled above)."</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">"price"</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">"0"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Users will need to spend this amount to get free shipping (if enabled above)."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"_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/v2/shipping/zones/5/methods/27"</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/v2/shipping/zones/5/methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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-shipping-method-of-a-shipping-zone'>Update a shipping method of a shipping zone</h2>
|
|
<p>This API lets you make changes to a shipping method of a shipping zone.</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/v2/shipping/zones/<zone_id>/methods/<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/v2/shipping/zones/5/methods/26 <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">'{
|
|
"settings": {
|
|
"cost": "20.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">settings</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="na">cost</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="nx">WooCommerce</span><span class="p">.</span><span class="nx">put</span><span class="p">(</span><span class="dl">"</span><span class="s2">shipping/zones/5/methods/26</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="p">[</span>
|
|
<span class="s1">'cost'</span> <span class="o">=></span> <span class="s1">'20.00'</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">'shipping/zones/5/methods/26'</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="p">{</span>
|
|
<span class="s">"cost"</span><span class="p">:</span> <span class="s">"20.00"</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">"shipping/zones/5/methods/26"</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="p">{</span>
|
|
<span class="s2">"cost"</span><span class="p">:</span> <span class="s2">"20.00"</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">"shipping/zones/5/methods/26"</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">"instance_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">"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">"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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Lets you charge a fixed rate for shipping.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Method title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Flat rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"tax_status"</span><span class="p">:</span><span class="w"> </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">"tax_status"</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">"Tax status"</span><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">"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">"value"</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">"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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"taxable"</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">"none"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"cost"</span><span class="p">:</span><span class="w"> </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">"cost"</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">"Cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">"20.00"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_costs"</span><span class="p">:</span><span class="w"> </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">"class_costs"</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">"Shipping class costs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</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">"title"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_cost_92"</span><span class="p">:</span><span class="w"> </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">"class_cost_92"</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">"</span><span class="se">\"</span><span class="s2">Express</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class_cost_91"</span><span class="p">:</span><span class="w"> </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">"class_cost_91"</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">"</span><span class="se">\"</span><span class="s2">Priority</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"no_class_cost"</span><span class="p">:</span><span class="w"> </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">"no_class_cost"</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">"No shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"type"</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">"Calculation type"</span><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">"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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"class"</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">"class"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per class: Charge shipping for each shipping class individually"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per order: Charge shipping for the most expensive shipping 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="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/v2/shipping/zones/5/methods/26"</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/v2/shipping/zones/5/methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-method-from-a-shipping-zone'>Delete a shipping method from a shipping zone</h2>
|
|
<p>This API helps you delete a shipping method from a shipping zone.</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/v2/shipping/zones/<zone_id>/methods/<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/v2/shipping/zones/5/methods/26?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">shipping/zones/5/methods/26</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">'shipping/zones/5/methods/26'</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">"shipping/zones/5/methods/26"</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">"shipping/zones/5/methods/26"</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">"instance_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">"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">"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">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"flat_rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"method_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<p>Lets you charge a fixed rate for shipping.</p></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"settings"</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="p">{</span><span class="w">
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"title"</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">"Method title"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</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">"text"</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">"Flat rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This controls the title which the user sees during checkout."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"tax_status"</span><span class="p">:</span><span class="w"> </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">"tax_status"</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">"Tax status"</span><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">"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">"value"</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">"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">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"taxable"</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">"none"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"cost"</span><span class="p">:</span><span class="w"> </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">"cost"</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">"Cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">"20.00"</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_costs"</span><span class="p">:</span><span class="w"> </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">"class_costs"</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">"Shipping class costs"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</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">"title"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"These costs can optionally be added based on the <a href=</span><span class="se">\"</span><span class="s2">https://example.com/wp-admin/admin.php?page=wc-settings&tab=shipping&section=classes</span><span class="se">\"</span><span class="s2">>product shipping class</a>."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</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">"class_cost_92"</span><span class="p">:</span><span class="w"> </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">"class_cost_92"</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">"</span><span class="se">\"</span><span class="s2">Express</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"class_cost_91"</span><span class="p">:</span><span class="w"> </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">"class_cost_91"</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">"</span><span class="se">\"</span><span class="s2">Priority</span><span class="se">\"</span><span class="s2"> shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"no_class_cost"</span><span class="p">:</span><span class="w"> </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">"no_class_cost"</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">"No shipping class cost"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</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">"text"</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">""</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">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Enter a cost (excl. tax) or sum, e.g. <code>10.00 * [qty]</code>.<br/><br/>Use <code>[qty]</code> for the number of items, <br/><code>[cost]</code> for the total cost of items, and <code>[fee percent=</span><span class="se">\"</span><span class="s2">10</span><span class="se">\"</span><span class="s2"> min_fee=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> max_fee=</span><span class="se">\"\"</span><span class="s2">]</code> for percentage based fees."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">"N/A"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"type"</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">"Calculation type"</span><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">"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">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"class"</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">"class"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"tip"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"placeholder"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</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="nl">"class"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per class: Charge shipping for each shipping class individually"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"order"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Per order: Charge shipping for the most expensive shipping 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="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/v2/shipping/zones/5/methods/26"</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/v2/shipping/zones/5/methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"describes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"href"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://example.com/wp-json/wc/v2/shipping/zones/5"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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='shipping-methods'>Shipping methods</h1>
|
|
<p>The shipping methods API allows you to view individual shipping methods.</p>
|
|
<h2 id='shipping-method-properties'>Shipping method properties</h2>
|
|
<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>Method ID. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>title</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method title. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Shipping method description. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='retrieve-a-shipping-method'>Retrieve a shipping method</h2>
|
|
<p>This API lets you retrieve and view a specific shipping method.</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/v2/shipping_methods/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping_methods/flat_rate <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">shipping_methods/flat_rate</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">'shipping_methods/flat_rate'</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">"shipping_methods/flat_rate"</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">"shipping_methods/flat_rate"</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="s2">"flat_rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lets you charge a fixed rate for shipping."</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/v2/shipping_methods/flat_rate"</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/v2/shipping_methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-methods'>List all shipping methods</h2>
|
|
<p>This API helps you to view all the shipping methods.</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/v2/shipping_methods</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/shipping_methods <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">shipping_methods</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">'shipping_methods'</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">"shipping_methods"</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">"shipping_methods"</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="s2">"flat_rate"</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">"Flat rate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Lets you charge a fixed rate for shipping."</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/v2/shipping_methods/flat_rate"</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/v2/shipping_methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"free_shipping"</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">"Free shipping"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Free shipping is a special method which can be triggered with coupons and minimum spends."</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/v2/shipping_methods/free_shipping"</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/v2/shipping_methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"local_pickup"</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">"Local pickup"</span><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 customers to pick up orders themselves. By default, when using local pickup store base taxes will apply regardless of customer address."</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/v2/shipping_methods/local_pickup"</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/v2/shipping_methods"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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='system-status'>System status</h1>
|
|
<p>The system status API allows you to view all system status items.</p>
|
|
<h2 id='system-status-properties'>System status properties</h2>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>environment</code></td>
|
|
<td>object</td>
|
|
<td>Environment. See <a href="#system-status-environment-properties">System status - Environment properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>database</code></td>
|
|
<td>object</td>
|
|
<td>Database. See <a href="#system-status-database-properties">System status - Database properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>active_plugins</code></td>
|
|
<td>array</td>
|
|
<td>Active plugins. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>theme</code></td>
|
|
<td>object</td>
|
|
<td>Theme. See <a href="#system-status-theme-properties">System status - Theme properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>settings</code></td>
|
|
<td>object</td>
|
|
<td>Settings. See <a href="#system-status-settings-properties">System status - Settings properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>security</code></td>
|
|
<td>object</td>
|
|
<td>Security. See <a href="#system-status-security-properties">System status - Security properties</a> <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>pages</code></td>
|
|
<td>array</td>
|
|
<td>WooCommerce pages. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='system-status-environment-properties'>System status - Environment properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>home_url</code></td>
|
|
<td>string</td>
|
|
<td>Home URL. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>site_url</code></td>
|
|
<td>string</td>
|
|
<td>Site URL. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wc_version</code></td>
|
|
<td>string</td>
|
|
<td>WooCommerce version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>log_directory</code></td>
|
|
<td>string</td>
|
|
<td>Log directory. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>log_directory_writable</code></td>
|
|
<td>boolean</td>
|
|
<td>Is log directory writable? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wp_version</code></td>
|
|
<td>string</td>
|
|
<td>WordPress version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wp_multisite</code></td>
|
|
<td>boolean</td>
|
|
<td>Is WordPress multisite? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wp_memory_limit</code></td>
|
|
<td>integer</td>
|
|
<td>WordPress memory limit. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wp_debug_mode</code></td>
|
|
<td>boolean</td>
|
|
<td>Is WordPress debug mode active? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wp_cron</code></td>
|
|
<td>boolean</td>
|
|
<td>Are WordPress cron jobs enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>wp_environment_type</code></td>
|
|
<td>string</td>
|
|
<td>WordPress environment type. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>language</code></td>
|
|
<td>string</td>
|
|
<td>WordPress language. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>server_info</code></td>
|
|
<td>string</td>
|
|
<td>Server info. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>php_version</code></td>
|
|
<td>string</td>
|
|
<td>PHP version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>php_post_max_size</code></td>
|
|
<td>integer</td>
|
|
<td>PHP post max size. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>php_max_execution_time</code></td>
|
|
<td>integer</td>
|
|
<td>PHP max execution time. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>php_max_input_vars</code></td>
|
|
<td>integer</td>
|
|
<td>PHP max input vars. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>curl_version</code></td>
|
|
<td>string</td>
|
|
<td>cURL version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>suhosin_installed</code></td>
|
|
<td>boolean</td>
|
|
<td>Is SUHOSIN installed? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>max_upload_size</code></td>
|
|
<td>integer</td>
|
|
<td>Max upload size. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>mysql_version</code></td>
|
|
<td>string</td>
|
|
<td>MySQL version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default_timezone</code></td>
|
|
<td>string</td>
|
|
<td>Default timezone. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fsockopen_or_curl_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Is fsockopen/cURL enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>soapclient_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Is SoapClient class enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>domdocument_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Is DomDocument class enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>gzip_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Is GZip enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>mbstring_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Is mbstring enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>remote_post_successful</code></td>
|
|
<td>boolean</td>
|
|
<td>Remote POST successful? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>remote_post_response</code></td>
|
|
<td>string</td>
|
|
<td>Remote POST response. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>remote_get_successful</code></td>
|
|
<td>boolean</td>
|
|
<td>Remote GET successful? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>remote_get_response</code></td>
|
|
<td>string</td>
|
|
<td>Remote GET response. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='system-status-database-properties'>System status - Database properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>wc_database_version</code></td>
|
|
<td>string</td>
|
|
<td>WC database version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>database_prefix</code></td>
|
|
<td>string</td>
|
|
<td>Database prefix. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>maxmind_geoip_database</code></td>
|
|
<td>string</td>
|
|
<td>MaxMind GeoIP database. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>database_tables</code></td>
|
|
<td>array</td>
|
|
<td>Database tables. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='system-status-theme-properties'>System status - Theme properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Theme name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>version</code></td>
|
|
<td>string</td>
|
|
<td>Theme version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>version_latest</code></td>
|
|
<td>string</td>
|
|
<td>Latest version of theme. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>author_url</code></td>
|
|
<td>string</td>
|
|
<td>Theme author URL. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>is_child_theme</code></td>
|
|
<td>boolean</td>
|
|
<td>Is this theme a child theme? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>has_woocommerce_support</code></td>
|
|
<td>boolean</td>
|
|
<td>Does the theme declare WooCommerce support? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>has_woocommerce_file</code></td>
|
|
<td>boolean</td>
|
|
<td>Does the theme have a woocommerce.php file? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>has_outdated_templates</code></td>
|
|
<td>boolean</td>
|
|
<td>Does this theme have outdated templates? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>overrides</code></td>
|
|
<td>array</td>
|
|
<td>Template overrides. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_name</code></td>
|
|
<td>string</td>
|
|
<td>Parent theme name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_version</code></td>
|
|
<td>string</td>
|
|
<td>Parent theme version. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>parent_author_url</code></td>
|
|
<td>string</td>
|
|
<td>Parent theme author URL. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='system-status-settings-properties'>System status - Settings properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>api_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>REST API enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>force_ssl</code></td>
|
|
<td>boolean</td>
|
|
<td>SSL forced? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency</code></td>
|
|
<td>string</td>
|
|
<td>Currency. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency_symbol</code></td>
|
|
<td>string</td>
|
|
<td>Currency symbol. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>currency_position</code></td>
|
|
<td>string</td>
|
|
<td>Currency position. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>thousand_separator</code></td>
|
|
<td>string</td>
|
|
<td>Thousand separator. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>decimal_separator</code></td>
|
|
<td>string</td>
|
|
<td>Decimal separator. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>number_of_decimals</code></td>
|
|
<td>integer</td>
|
|
<td>Number of decimals. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>geolocation_enabled</code></td>
|
|
<td>boolean</td>
|
|
<td>Geolocation enabled? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>taxonomies</code></td>
|
|
<td>array</td>
|
|
<td>Taxonomy terms for product/order statuses. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h3 id='system-status-security-properties'>System status - Security properties</h3>
|
|
<table><thead>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead><tbody>
|
|
<tr>
|
|
<td><code>secure_connection</code></td>
|
|
<td>boolean</td>
|
|
<td>Is the connection to your store secure? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>hide_errors</code></td>
|
|
<td>boolean</td>
|
|
<td>Hide errors from visitors? <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='list-all-system-status-items'>List all system status items</h2>
|
|
<p>This API helps you to view all the system status items.</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/v2/system_status</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/system_status <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">system_status</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">'system_status'</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">"system_status"</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">"system_status"</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">"environment"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"home_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"site_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://example.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"log_directory"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/var/www/woocommerce/wp-content/uploads/wc-logs/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"log_directory_writable"</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">"wp_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.7.3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"wp_multisite"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"wp_memory_limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">134217728</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"wp_debug_mode"</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">"wp_cron"</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">"wp_environment_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"production"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"language"</span><span class="p">:</span><span class="w"> </span><span class="s2">"en_US"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"server_info"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Apache/2.4.18 (Ubuntu)"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"php_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.1.3-2+deb.sury.org~yakkety+1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"php_post_max_size"</span><span class="p">:</span><span class="w"> </span><span class="mi">8388608</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"php_max_execution_time"</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">"php_max_input_vars"</span><span class="p">:</span><span class="w"> </span><span class="mi">1000</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"curl_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7.50.1, OpenSSL/1.0.2g"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"suhosin_installed"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"max_upload_size"</span><span class="p">:</span><span class="w"> </span><span class="mi">2097152</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"mysql_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5.7.17"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"default_timezone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"UTC"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"fsockopen_or_curl_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"soapclient_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"domdocument_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"gzip_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"mbstring_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"remote_post_successful"</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">"remote_post_response"</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">"remote_get_successful"</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">"remote_get_response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"200"</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="nl">"database"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"wc_database_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3.0.0"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"database_prefix"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wp_"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"maxmind_geoip_database"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/var/www/woocommerce/wp-content/uploads/GeoIP.dat"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"database_tables"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"woocommerce_sessions"</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">"woocommerce_api_keys"</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">"woocommerce_attribute_taxonomies"</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">"woocommerce_downloadable_product_permissions"</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">"woocommerce_order_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">"woocommerce_order_itemmeta"</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">"woocommerce_tax_rates"</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">"woocommerce_tax_rate_locations"</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">"woocommerce_shipping_zones"</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">"woocommerce_shipping_zone_locations"</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">"woocommerce_shipping_zone_methods"</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">"woocommerce_payment_tokens"</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">"woocommerce_payment_tokenmeta"</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="nl">"active_plugins"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"plugin"</span><span class="p">:</span><span class="w"> </span><span class="s2">"woocommerce/woocommerce.php"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WooCommerce"</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">"3.0.0-rc.1"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"version_latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.6.14"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://woocommerce.com/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"author_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Automattic"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"author_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://woocommerce.com"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"network_activated"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">],</span><span class="w">
|
|
</span><span class="nl">"theme"</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">"Twenty Sixteen"</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">"1.3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"version_latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.3"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"author_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://wordpress.org/"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"is_child_theme"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_woocommerce_support"</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">"has_woocommerce_file"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"has_outdated_templates"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"overrides"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
|
</span><span class="nl">"parent_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">"parent_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent_version_latest"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"parent_author_url"</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">"settings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"api_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"force_ssl"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"USD"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency_symbol"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&#36;"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"currency_position"</span><span class="p">:</span><span class="w"> </span><span class="s2">"left"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"thousand_separator"</span><span class="p">:</span><span class="w"> </span><span class="s2">","</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"decimal_separator"</span><span class="p">:</span><span class="w"> </span><span class="s2">"."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"number_of_decimals"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"geolocation_enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"taxonomies"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"external"</span><span class="p">:</span><span class="w"> </span><span class="s2">"external"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"grouped"</span><span class="p">:</span><span class="w"> </span><span class="s2">"grouped"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"simple"</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">"variable"</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="p">},</span><span class="w">
|
|
</span><span class="nl">"security"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"secure_connection"</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">"hide_errors"</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">"pages"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"page_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Shop base"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_set"</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">"page_exists"</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">"page_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">"shortcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shortcode_required"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shortcode_present"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</span><span class="p">{</span><span class="w">
|
|
</span><span class="nl">"page_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Cart"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_set"</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">"page_exists"</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">"page_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">"shortcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[woocommerce_cart]"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shortcode_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">"shortcode_present"</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="nl">"page_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Checkout"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_set"</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">"page_exists"</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">"page_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">"shortcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[woocommerce_checkout]"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shortcode_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">"shortcode_present"</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="nl">"page_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"My account"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"page_set"</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">"page_exists"</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">"page_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">"shortcode"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[woocommerce_my_account]"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"shortcode_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">"shortcode_present"</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></code></pre></div><h1 id='system-status-tools'>System status tools</h1>
|
|
<p>The system status tools API allows you to view and run tools from system status.</p>
|
|
<h2 id='system-status-tool-properties'>System status tool properties</h2>
|
|
<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>A unique identifier for the tool. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td>string</td>
|
|
<td>Tool name. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>action</code></td>
|
|
<td>string</td>
|
|
<td>What running the tool will do. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>description</code></td>
|
|
<td>string</td>
|
|
<td>Tool description. <i class="label label-info">read-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>success</code></td>
|
|
<td>boolean</td>
|
|
<td>Did the tool run successfully? <i class="label label-info">read-only</i> <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>message</code></td>
|
|
<td>string</td>
|
|
<td>Tool return message. <i class="label label-info">read-only</i> <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>confirm</code></td>
|
|
<td>boolean</td>
|
|
<td>Confirm execution of the tool. Default is <code>false</code>. <i class="label label-info">write-only</i></td>
|
|
</tr>
|
|
</tbody></table>
|
|
<h2 id='retrieve-a-tool-from-system-status'>Retrieve a tool from system status</h2>
|
|
<p>This API lets you retrieve and view a specific tool from system status by ID.</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/v2/system_status/tools/<id></h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/system_status/tools/clear_transients <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">system_status/tools/clear_transients</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">'system_status/tools/clear_transients'</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">"system_status/tools/clear_transients"</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">"system_status/tools/clear_transients"</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="s2">"clear_transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WC transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will clear the product/shop transients cache."</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/v2/system_status/tools/clear_transients"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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-tools-from-system-status'>List all tools from system status</h2>
|
|
<p>This API helps you to view all tools from system status.</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/v2/system_status/tools</h6>
|
|
</div>
|
|
</div>
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl https://example.com/wp-json/wc/v2/system_status/tools <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">system_status/tools</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">'system_status/tools'</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">"system_status/tools"</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">"system_status/tools"</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="s2">"clear_transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WC transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will clear the product/shop transients cache."</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/v2/system_status/tools/clear_transients"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"clear_expired_transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Expired transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear expired transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will clear ALL expired transients from WordPress."</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/v2/system_status/tools/clear_expired_transients"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"delete_orphaned_variations"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Orphaned variations"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Delete orphaned variations"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will delete all variations which have no parent."</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/v2/system_status/tools/delete_orphaned_variations"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"clear_expired_download_permissions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Used-up download permissions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clean up download permissions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will delete expired download permissions and permissions with 0 remaining downloads."</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/v2/system_status/tools/clear_expired_download_permissions"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"regenerate_product_lookup_tables"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product lookup tables"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Regenerate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will regenerate product lookup table data. This process may take a while."</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/v2/system_status/tools/regenerate_product_lookup_tables"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"repair_coupons_lookup_table"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Coupons lookup table"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Repair"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will repair the coupons lookup table data with missing discount amounts. This process may take a while."</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/v2/system_status/tools/repair_coupons_lookup_table"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"recount_terms"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Term counts"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Recount terms"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will recount product terms - useful when changing your settings in a way which hides products from the catalog."</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/v2/system_status/tools/recount_terms"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"reset_roles"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Capabilities"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reset capabilities"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will reset the admin, customer and shop_manager roles to default. Use this if your users cannot access all of the WooCommerce admin pages."</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/v2/system_status/tools/reset_roles"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"clear_sessions"</span><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 sessions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear all sessions"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<strong class=</span><span class="se">\"</span><span class="s2">red</span><span class="se">\"</span><span class="s2">>Note:</strong> This tool will delete all customer session data from the database, including any current live carts."</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/v2/system_status/tools/clear_sessions"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"clear_template_cache"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear template cache"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<strong class=</span><span class="se">\"</span><span class="s2">red</span><span class="se">\"</span><span class="s2">>Note:</strong> This tool will empty the template cache."</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/v2/system_status/tools/clear_template_cache"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"clear_system_status_theme_info_cache"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear system status theme info cache"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<strong class=</span><span class="se">\"</span><span class="s2">red</span><span class="se">\"</span><span class="s2">>Note:</strong> This tool will empty the system status theme info cache."</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/v2/system_status/tools/clear_system_status_theme_info_cache"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"install_pages"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Install WooCommerce pages"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Install pages"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<strong class=</span><span class="se">\"</span><span class="s2">red</span><span class="se">\"</span><span class="s2">>Note:</strong> This tool will install all the missing WooCommerce pages. Pages already defined and set up will not be replaced."</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/v2/system_status/tools/install_pages"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"delete_taxes"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Delete all WooCommerce tax rates"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Delete ALL tax rates"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<strong class=</span><span class="se">\"</span><span class="s2">red</span><span class="se">\"</span><span class="s2">>Note:</strong> This option will delete ALL of your tax rates, use with caution."</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/v2/system_status/tools/delete_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">"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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"regenerate_thumbnails"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Regenerate shop thumbnails"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Regenerate"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This will regenerate all shop thumbnails to match your theme and/or image settings."</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/v2/system_status/tools/regenerate_thumbnails"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"db_update_routine"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Update database"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Update database"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"<strong class=</span><span class="se">\"</span><span class="s2">red</span><span class="se">\"</span><span class="s2">>Note:</strong> This tool will update your WooCommerce database to the latest version. Please ensure you make sufficient backups before proceeding."</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/v2/system_status/tools/db_update_routine"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"recreate_order_address_fts_index"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Re-create Order Address FTS index"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Recreate index"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will recreate the full text search index for order addresses. If the index does not exist, it will try to create it."</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/v2/system_status/tools/recreate_order_address_fts_index"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">},</span><span class="w">
|
|
</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">"verify_db_tables"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Verify base database tables"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Verify database"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Verify if all base database tables are present."</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/v2/system_status/tools/verify_db_tables"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><span class="p">]</span><span class="w">
|
|
</span><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='run-a-tool-from-system-status'>Run a tool from system status</h2>
|
|
<p>This API lets you run a tool from system status.</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/v2/system_status/tools/<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/v2/system_status/tools/clear_transients <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">'{
|
|
"confirm": 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">confirm</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">put</span><span class="p">(</span><span class="dl">"</span><span class="s2">system_status/tools/clear_transients</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">'confirm'</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">put</span><span class="p">(</span><span class="s1">'system_status/tools/clear_transients'</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">"confirm"</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">put</span><span class="p">(</span><span class="s">"system_status/tools/clear_transients"</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">confirm: </span><span class="kp">true</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">"system_status/tools/clear_transients"</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="s2">"clear_transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WC transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"action"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Clear transients"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This tool will clear the product/shop transients cache."</span><span class="p">,</span><span class="w">
|
|
</span><span class="nl">"success"</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">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Product transients cleared"</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/v2/system_status/tools/clear_transients"</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/v2/system_status/tools"</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span><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>
|
|
|
|
|
|
</body>
|
|
</html>
|
