Extends @woocommerce/woocommerce-rest-api
with more descriptive methods.
- Installation
- Usage
- Coupons
- Customers
- Orders
- Order Notes
- Order Refunds
- Products
- Product Variations
- Product Attributes
- Product Attribute Terms
- Product Categories
npm i woojs
const Woo = require("woojs");
const woo = new Woo(url, consumerKey, consumerSecret);
Woo(url, key, secret {options})
Parameter | Type | Required | Description |
---|---|---|---|
url |
string | yes | WooCommerce store URL |
key |
string | yes | Consumer Key |
secret |
string | yes | Consumer Secret |
options |
object | no | Options object |
Option | Type | Default | Description |
---|---|---|---|
version |
string | 'wc/v3' | WooCommerce REST API version |
queryStringAuth |
boolean | false | Use query string authentication instead of using the Authorization header. |
timeout |
number | 5000 | Request timeout in milliseconds. |
encoding |
string | 'utf8' | Request encoding. |
port |
string | '' | Request port. |
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the object READ-ONLY |
code |
string | Coupon code. MANDATORY |
amount |
string | Amount of discount. |
date_created |
date-time | The date the coupon was created. READ-ONLY |
date_created_gmt |
date-time | The date the coupon was created, as GMT. READ-ONLY |
date_modified |
date-time | The date the coupon was last modified. READ-ONLY |
date_modified_gmt |
date-time | The date the coupon was last modified, as GMT. READ-ONLY |
discount_type |
string | Determines the type of discount that will be applied. Options: percent , fixed_cart and fixed_product . Default is fixed_cart . |
description |
string | Coupon description. |
date_expires |
date-time | Coupon expiry date. |
date_expires_gmt |
date-time | Coupon expiry date, as GMT. |
usage_count |
integer | Number of times the coupon has been used already. READ-ONLY |
individual_use |
boolean | If true, the coupon can only be used individually. Other applied coupons will be removed from the cart. Default is false . |
product_ids |
array | List of product IDs the coupon can be used on. |
excluded_product_ids |
array | List of product IDs the coupon cannot be used on. |
usage_limit |
integer | How many times the coupon can be used in total. |
usage_limit_per_user |
integer | How many times the coupon can be used per customer. |
limit_usage_to_x_items |
integer | Maximum number of items in the cart the coupon can be applied to. |
free_shipping |
boolean | If true and if the free shipping method requires a coupon, this coupon will enable free shipping. Default is false . |
product_categories |
array | List of category IDs the coupon can be used on. |
excluded_product_categories |
array | List of category IDs the coupon cannot be used on. |
exclude_sale_items |
boolean | If true, the coupon will not apply to items that have sale prices. Default is false . |
minimum_amount |
string | Minimum order amount that needs to be in the cart before coupon applies. |
maximum_amount |
string | Maximum order amount allowed when using the coupon. |
email_restrictions |
array | List of email addresses that can use this coupon. |
used_by |
array | List of user IDs who have used the coupon. READ-ONLY |
meta_data |
array | Meta data. See Coupon - Meta data properties |
Attribute | Type | Description |
---|---|---|
id |
integer | Meta ID. |
key |
string | Meta key. |
value |
string | Meta value. |
.couponCreate()
or .couponAdd()
(method) Woo.couponCreate(data: object): object
(method) Woo.couponAdd(data: object): object
Creates a new coupon.
Example:
woo
.couponCreate(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.couponRetrieve()
or .couponGet()
(method) Woo.couponRetrieve(id: number): object
(method) Woo.couponGet(id: number): object
Retrieve and view a specific coupon by ID.
Example:
woo
.couponRetrieve(id)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.couponGet(id)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.couponList()
or .couponGetAll()
(method) Woo.couponList(params?: object): object
(method) Woo.couponGetAll(params?: object): object
List all coupons.
Example:
woo
.couponList()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.couponGetAll()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
dates_are_gmt |
boolean | Whether to consider GMT post dates when limiting response by published or modified date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is asc . |
orderby |
string | Sort collection by object attribute. Options: date , id , include , title , slug . Default is date . |
code |
string | Limit result set to coupons with a specific code. |
.couponUpdate()
or .couponEdit()
(method) Woo.couponUpdate(id: number, data: object): object
(method) Woo.couponEdit(id: number, data: object): object
Make changes to a coupon.
Example:
woo
.couponUpdate(id, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.couponDelete()
or .couponRemove()
(method) Woo.couponDelete(id: number, params?: object): object
(method) Woo.couponRemove(id: number, params?: object): object
Delete a coupon.
Example:
woo
.couponDelete(id, { force: true }})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
force |
boolean | Use true whether to permanently delete the coupon, Default is false . |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.couponBatchUpdate()
or .couponBatch()
(method) Woo.couponBatchUpdate(data: object): object
(method) Woo.couponBatch(data: object): object
Update multiple coupons.
Example:
const data = {
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
]
};
woo.couponBatchUpdate(, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Property | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
date_created |
date-time | The date the customer was created, in the site's timezone. READ-ONLY |
date_created_gmt |
date-time | The date the customer was created, as GMT. READ-ONLY |
date_modified |
date-time | The date the customer was last modified, in the site's timezone. READ-ONLY |
date_modified_gmt |
date-time | The date the customer was last modified, as GMT. READ-ONLY |
email |
string | Customer email address. MANDATORY |
first_name |
string | Customer first name. |
last_name |
string | Customer last name. |
role |
string | Customer role. READ-ONLY |
username |
string | Customer login name. |
password |
string | Customer password. WRITE-ONLY |
billing |
object | List of billing address data. See Customer - Billing Properties |
shipping |
object | List of shipping address data. See Customer - Shipping Properties |
is_paying_customer |
boolean | Shows if the customer is a paying customer. READ-ONLY |
avatar_url |
string | Avatar URL. READ-ONLY |
meta_data |
array | Meta data. See Customer - Meta data properties |
Attribute | Type | Description |
---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1. |
address_2 |
string | Address line 2. |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | ISO code of the country. |
email |
string | Email address. |
phone |
string | Phone number. |
Attribute | Type | Description |
---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1. |
address_2 |
string | Address line 2. |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | ISO code of the country. |
Attribute | Type | Description |
---|---|---|
id |
number | Meta ID. READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
.customerCreate()
or .customerAdd()
(method) Woo.customerCreate(data: object): object
(method) Woo.customerAdd(data: object): object
Create a customer.
Example:
woo
.customerCreate(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.customerRetrieve()
or .customerGet()
(method) Woo.customerRetrieve(id: number): object
(method) Woo.customerGet(id: number): object
Retrieve and view a specific customer by ID.
Example:
woo
.customerRetrieve(1)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.customerList()
or .customerGetAll()
(method) Woo.customerList(params?: object): object
(method) Woo.customerGetAll(params?: object): object
View all the customers.
Example:
woo
.customerList()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is asc . |
orderby |
string | Sort collection by object attribute. Options: id , include , name and registered_date . Default is name . |
email |
string | Limit result set to resources with a specific email. |
role |
string | Limit result set to resources with a specific role. Options: all , administrator , editor , author , contributor , subscriber , customer and shop_manager . Default is customer . |
.customerUpdate()
or .customerEdit()
(method) Woo.customerUpdate(id: number, data: object): object
(method) Woo.customerEdit(id: number, data: object): object
Update a customer.
Example:
woo
.customerUpdate(1, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.customerDelete()
or .customerRemove()
(method) Woo.customerDelete(id: number, params?: object): object
(method) Woo.customerRemove(id: number, params?: object): object
Delete a customer.
Example:
woo
.customerDelete(1)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
reassign |
integer | User ID to reassign posts to. |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.customerBatch()
or .customerBatchUpdate()
(method) Woo.customerBatch(data: object): object
(method) Woo.customerBatchUpdate(data: object): object
Update multiple customers in a single request.
Example:
const data = {
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: [11],
};
woo
.customerBatch(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.customerDownloads()
(method) Woo.customerDownloads(id: number): object
Retrieve customer downloads permissions.
Example:
woo
.customerDownloads(1)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
parent_id |
integer | Order parent ID. |
number |
string | Order number. READ-ONLY |
order_key |
string | Order key. READ-ONLY |
created_via |
string | Shows where the order was created. READ-ONLY |
version |
string | Version of WooCommerce which last updated the order. READ-ONLY |
status |
string | Order status. Options: pending , processing , on-hold , completed , cancelled , refunded , failed and trash . Default is pending . |
currency |
string | Currency the order was created with, in ISO format. Options: AED , AFN , ALL , AMD , ANG , AOA , ARS , AUD , AWG , AZN , BAM , BBD , BDT , BGN , BHD , BIF , BMD , BND , BOB , BRL , BSD , BTC , BTN , BWP , BYR , BZD , CAD , CDF , CHF , CLP , CNY , COP , CRC , CUC , CUP , CVE , CZK , DJF , DKK , DOP , DZD , EGP , ERN , ETB , EUR , FJD , FKP , GBP , GEL , GGP , GHS , GIP , GMD , GNF , GTQ , GYD , HKD , HNL , HRK , HTG , HUF , IDR , ILS , IMP , INR , IQD , IRR , IRT , ISK , JEP , JMD , JOD , JPY , KES , KGS , KHR , KMF , KPW , KRW , KWD , KYD , KZT , LAK , LBP , LKR , LRD , LSL , LYD , MAD , MDL , MGA , MKD , MMK , MNT , MOP , MRO , MUR , MVR , MWK , MXN , MYR , MZN , NAD , NGN , NIO , NOK , NPR , NZD , OMR , PAB , PEN , PGK , PHP , PKR , PLN , PRB , PYG , QAR , RON , RSD , RUB , RWF , SAR , SBD , SCR , SDG , SEK , SGD , SHP , SLL , SOS , SRD , SSP , STD , SYP , SZL , THB , TJS , TMT , TND , TOP , TRY , TTD , TWD , TZS , UAH , UGX , USD , UYU , UZS , VEF , VND , VUV , WST , XAF , XCD , XOF , XPF , YER , ZAR and ZMW . Default is USD . |
date_created |
date-time | The date the order was created, in the site's timezone. READ-ONLY |
date_created_gmt |
date-time | The date the order was created, as GMT. READ-ONLY |
date_modified |
date-time | The date the order was last modified, in the site's timezone. READ-ONLY |
date_modified_gmt |
date-time | The date the order was last modified, as GMT. READ-ONLY |
discount_total |
string | Order discount total. READ-ONLY |
discount_tax |
string | Order discount tax. READ-ONLY |
shipping_total |
string | Order shipping total. READ-ONLY |
shipping_tax |
string | Order shipping tax. READ-ONLY |
cart_tax |
string | Order cart tax. READ-ONLY |
total |
string | Order total. READ-ONLY |
total_tax |
string | Order total tax. READ-ONLY |
prices_include_tax |
boolean | Are prices inclusive of tax. READ-ONLY |
customer_id |
integer | User ID who owns the order. 0 for guests. Default is 0 . |
customer_ip_address |
string | Customer IP address. READ-ONLY |
customer_user_agent |
string | Customer user agent. READ-ONLY |
customer_note |
string | Customer note. |
billing |
object | Billing address. See Order - Billing properties |
shipping |
object | Shipping address. See Order - Shipping properties |
payment_method |
string | Payment method ID. |
payment_method_title |
string | Payment method title. |
transaction_id |
string | Transaction ID. |
date_paid |
date-time | Date the order was paid. READ-ONLY |
date_paid_gmt |
date-time | Date the order was paid, as GMT. READ-ONLY |
date_completed |
date-time | Date the order was completed. READ-ONLY |
date_completed_gmt |
date-time | Date the order was completed, as GMT. READ-ONLY |
cart_hash |
string | MD5 hash of cart items to ensure orders are not modified. READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
line_items |
array | Line items. See Order - Line items properties |
tax_lines |
array | Tax lines. See Order - Tax lines properties READ-ONLY |
shipping_lines |
array | Shipping lines. See Order - Shipping lines properties |
fee_lines |
array | Fee lines. See Order - Fee lines properties |
coupon_lines |
array | Coupon lines. See Order - Coupon lines properties |
refunds |
array | Refunds. See Order - Refunds properties READ-ONLY |
set_paid |
boolean | Define if the order is paid. It will set the status to processing and reduce stock items. Default is false . WRITE-ONLY |
Attribute | Type | Description |
---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1. |
address_2 |
string | Address line 2. |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
email |
string | Email address. |
phone |
string | Phone number. |
Attribute | Type | Description |
---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1. |
address_2 |
string | Address line 2. |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
Attribute | Type | Description |
---|---|---|
id |
integer | Meta ID. READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. READ-ONLY |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Item quantity. |
tax_class |
string | Slug of the tax class of product. |
subtotal |
string | Line subtotal (before discounts). |
subtotal_tax |
string | Line subtotal tax (before discounts). READ-ONLY |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). READ-ONLY |
taxes |
array | Taxes data. See Order - Taxes properties READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
sku |
string | Stock keeping unit. READ-ONLY |
price |
integer | Product price. READ-ONLY |
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. READ-ONLY |
rate_code |
string | Tax rate code. READ-ONLY |
rate_id |
integer | Tax rate ID. READ-ONLY |
label |
string | Tax rate label. READ-ONLY |
compound |
boolean | Whether or not the tax is a compound tax. READ-ONLY |
tax_total |
string | Tax total (not including shipping taxes) READ-ONLY |
shipping_tax_total |
string | Shipping tax total READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. READ-ONLY |
method_title |
string | Shipping method name. |
method_id |
string | Shipping method ID. |
total |
string | Shipping total. |
total_tax |
string | Shipping tax total. READ-ONLY |
taxes |
array | Taxes data. See Order - Taxes properties READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID READ-ONLY |
name |
string | Fee name. |
tax_class |
string | Tax class of fee. |
tax_status |
string | Tax status of fee. Options: taxable and none . |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts).READ-ONLY |
taxes |
array | Taxes data. See Order - Taxes properties READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. READ-ONLY |
code |
string | Coupon Code. |
discount |
string | Discount total. READ-ONLY |
discount_tax |
string | Discount total tax. READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
Attribute | Type | Description |
---|---|---|
id |
integer | Refund ID. READ-ONLY |
reason |
string | Refund reason. READ-ONLY |
total |
string | Refund total. READ-ONLY |
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. READ-ONLY |
rate_code |
string | Tax rate code. READ-ONLY |
rate_id |
string | Tax rate ID. READ-ONLY |
label |
string | Tax rate label. READ-ONLY |
compound |
boolean | Show if is a compound tax rate. READ-ONLY |
tax_total |
string | Tax total (not including shipping taxes).READ-ONLY |
shipping_tax_total |
string | Shipping tax total. READ-ONLY |
meta_data |
array | Meta data. See Order - Meta data properties |
.orderCreate()
or .orderAdd()
(method) Woo.orderCreate(data: object): object
(method) Woo.orderAdd(data: object): object
Create a new order.
Example:
woo
.orderCreate(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderAdd(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.orderRetrieve()
or .orderGet()
(method) Woo.orderRetrieve(id: number, params?: object): object
(method) Woo.orderGet(id: number, params?: object): object
Retrieve and view a specific order by ID.
Example:
woo
.orderRetrieve(id)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderGet(id)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
dp |
string | Number of decimal points to use. |
.orderList()
or .orderGetAll()
(method) Woo.orderList(params?: object): object
(method) Woo.orderGetAll(params?: object): object
Retrieve and view a specific order by ID.
Example:
woo
.orderList(params)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderGetAll(params)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page | integer | Current page of the collection. Default is 1 . |
per_page | integer | Maximum number of items to be returned in result set. Default is 10 . |
search | string | Limit results to those matching a string. |
after | string | Limit response to resources published after a given ISO8601 compliant date. |
before | string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after | string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before | string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude | array | Ensure result set excludes specific IDs. |
include | array | Limit result set to specific ids. |
offset | integer | Offset the result set by a specific number of items. |
order | string | Order sort attribute ascending or descending. Options: asc and desc . Default is desc . |
orderby | string | Sort collection by object attribute. Options: date , id , include , title and slug . Default is date . |
parent | array | Limit result set to those of particular parent IDs. |
parent_exclude | array | Limit result set to all items except those of a particular parent ID. |
status | string | Limit result set to orders assigned a specific status. Options: any , pending , processing , on-hold , completed , cancelled , refunded , failed and trash . Default is any . |
customer | integer | Limit result set to orders assigned a specific customer ID. |
product | integer | Limit result set to orders that include a specific product ID. |
dp | string | Number of decimal points to use. Default is 2 . |
.orderUpdate()
or .orderEdit()
(method) Woo.orderUpdate(id: number, data: object): object
(method) Woo.orderEdit(id: number, data: object): object
Update a specific order by ID.
Example:
woo
.orderUpdate(id, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderEdit(id, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.orderDelete()
or .orderRemove()
(method) Woo.orderDelete(id: number, params?: object): object
(method) Woo.orderRemove(id: number, params?: object): object
Delete a specific order by ID.
Example:
woo
.orderDelete(id, params)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderRemove(id, params)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
force |
string | Use true whether to permanently delete the order, Default is false . |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.orderBatchUpdate()
or .orderBatch()
(method) Woo.orderBatchUpdate(data: object): object
(method) Woo.orderBatch(data: object): object
Update multiple orders in a single request.
Example:
const data = {
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],
};
woo
.orderBatchUpdate(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderBatch(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
author |
string | Note author. READ-ONLY |
date_created |
date-time | The date the note was created, in the site’s timezone. READ-ONLY |
date_created_gmt |
date-time | The date the note was created, as GMT. READ-ONLY |
note |
string | Note content. MANDATORY |
customer_note |
boolean | 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 false . |
added_by_user | boolean | If true , this note will be attributed to the current user. If false , the note will be attributed to the system. Default is false . |
.orderNoteCreate()
or .orderNoteAdd()
(method) Woo.orderNoteCreate(orderID: number, data: object): object
(method) Woo.orderNoteAdd(orderID: number, data: object): object
Create a new note for an order.
Example:
const data = {
note: "This is a note.",
customer_note: true,
};
woo
.orderNoteCreate(orderID, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderNoteAdd(orderID, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.orderNoteRetrieve()
or .orderNoteGet()
(method) Woo.orderNoteRetrieve(orderID: number, noteID: number): object
(method) Woo.orderNoteGet(orderID: number, noteID: number): object
Retrieve and view a specific note from an order.
Example:
woo
.orderNoteRetrieve(orderID, noteID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderNoteGet(orderID, noteID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.orderNoteList()
or .orderNoteGetAll()
(method) Woo.orderNoteList(orderID: number, params?: object): object
(method) Woo.orderNoteGetAll(orderID: number, params?: object): object
View all the notes from an order.
Example:
woo
.orderNoteList(orderID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderNoteGetAll(orderID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
type |
string | Limit result to customers or internal notes. Options: any , customer and internal . Default is any . |
.orderNoteDelete()
or .orderNoteRemove()
(method) (method) Woo.orderNoteDelete(orderID: number, noteID: number, params?: object): object
(method) Woo.orderNoteRemove(orderID: number, noteID: number, params?: object): object
Delete a specific note from an order.
Example:
woo
.orderNoteDelete(orderID, noteID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
woo
.orderNoteRemove(orderID, noteID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
force |
string | Required to be true , as resource does not support trashing. |
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
date_created |
date-time | The date the refund was created, in the site’s timezone. READ-ONLY |
date_created_gmt |
date-time | The date the refund was created, as GMT. READ-ONLY |
amount |
string | Total refund amount. Optional . If this parameter is provided, it will take precedence over line item totals, even when total of line items does not matches with this amount. |
reason |
string | Refund reason. |
refunded_by |
integer | ID of the user doing the refund. Default is the current user. |
refunded_payment | boolean | If the payment was refunded via the API. See api_refund . |
meta_data |
array | Meta data. See Order Refund Meta data properties. |
line_items |
array | List of line items. See Order Refund Line Items properties. |
| api_refund
| boolean | When true
, the payment gateway API is used to generate the refund. Default is true
. WRITE-ONLY
|
Attribute | Type | Description |
---|---|---|
id |
integer | Meta ID. READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
Attribute | Type | Description |
---|---|---|
id |
integer | Line item ID. READ-ONLY |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Quantity. |
tax_class |
integer | Tax class. |
subtotal |
string | Line item subtotal. |
subtotal_tax |
string | Line item subtotal tax. READ-ONLY |
total |
string | Line item total. |
total_tax |
string | Line item total tax. READ-ONLY |
taxes |
array | List of taxes. See Order Refund Line Item Taxes properties. |
meta_data |
array | Meta data. See Order Refund Meta data properties. |
sku |
string | SKU. |
price |
integer | Product price. |
refund_total |
number | Refund total. WRITE-ONLY |
Attribute | Type | Description |
---|---|---|
id |
integer | Tax ID. READ-ONLY |
total |
string | Tax total. READ-ONLY |
subtotal |
string | Tax subtotal. READ-ONLY |
refund_total |
string | The amount to refund for this tax WRITE-ONLY |
.refundCreate()
or .refundAdd()
(method) Woo.refundCreate(orderID: number, data: object): object
(method) Woo.refundAdd(orderID: number, data: object): object
Create a new refund for an order.
Example:
woo
.refundCreate(orderID, {
amount: "10.00",
reason: "Refund for order",
refunded_by: 1,
line_items: [
{
id: 1,
quantity: 1,
refund_total: 10,
},
],
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.refundRetrieve()
or .refundGet()
(method) Woo.refundRetrieve(orderID: number, refundID: number, params?: object): object
(method) Woo.refundGet(orderID: number, refundID: number, params?: object): object
Retrieve and view a specific refund from an order.
Example:
woo
.refundRetrieve(orderID, refundID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
dp |
string | Number of decimal points to use in each resource. |
.refundList()
or .refundGetAll()
(method) Woo.refundList(orderID: number, params?: object): object
(method) Woo.refundGetAll(orderID: number, params?: object): object
View all the refunds from an order.
Example:
woo
.refundList(orderID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is desc . |
orderby |
string | Sort collection by object attribute. Options: date , include , id , title and slug . Default is date . |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
dp |
string | Number of decimal points to use in each resource. |
.refundDelete()
or .refundRemove()
(method) Woo.refundDelete(orderID: number, refundID: number, params?: object): object
(method) Woo.refundRemove(orderID: number, refundID: number, params?: object): object
Delete an order refund.
Example:
woo
.refundDelete(orderID, refundID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
.productCreate()
or .productAdd()
(method) Woo.productCreate(data: object): object
(method) Woo.productAdd(data: object): object
Create a new product.
Example:
const data = {
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",
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg",
},
],
};
woo
.productCreate(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.productRetrieve()
or .productGet()
(method) Woo.productRetrieve(productID: number): object
(method) Woo.productGet(productID: number): object
Retrieve a product.
Example:
woo
.productRetrieve(productID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.productList()
or .productGetAll()
(method) Woo.productList(params?: object): object
(method) Woo.productGetAll(params?: object): object
View all products.
Example:
woo
.productList()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
dates_are_gmt |
boolean | Whether to consider GMT post dates when limiting response by published or modified date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is desc . |
orderby |
string | Sort collection by object attribute. Options: date , id , include , title , slug , price , popularity and rating . Default is date . |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
slug |
string | Limit result set to products with a specific slug. |
status |
string | Limit result set to products assigned a specific status. Options: any , draft , pending , private and publish . Default is any . |
type |
string | Limit result set to products assigned a specific type. Options: simple , grouped , external and variable . |
sku |
string | Limit result set to products with a specific SKU. |
featured |
boolean | Limit result set to featured products. |
category |
string | Limit result set to products assigned a specific category ID. |
tag |
string | Limit result set to products assigned a specific tag ID. |
shipping_class |
string | Limit result set to products assigned a specific shipping class ID. |
attribute |
string | Limit result set to products with a specific attribute. |
attribute_term |
string | Limit result set to products with a specific attribute term ID (required an assigned attribute). |
tax_class |
string | Limit result set to products with a specific tax class. Default options : standard , reduced-rate and zero-rate . |
on_sale |
boolean | Limit result set to products on sale. |
min_price |
string | Limit result set to products based on a minimum price. |
max_price |
string | Limit result set to products based on a maximum price. |
stock_status |
string | Limit result set to products with specified stock status. Options: instock , outofstock and onbackorder . |
.productUpdate()
or .productEdit()
(method) Woo.productUpdate(productID: number, data: object): object
(method) Woo.productEdit(productID: number, data: object): object
Update a product.
Example:
const data = {
regular_price: "24.54",
};
woo
.productUpdate(productID, data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
.productDelete()
or .productRemove()
(method) Woo.productDelete(productID: number, params?: object): object
(method) Woo.productRemove(productID: number, params?: object): object
Delete a product.
Example:
woo
.productDelete(productID)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Parameter | Type | Description |
---|---|---|
force |
string | Use true whether to permanently delete the product, Default is false . |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.productBatch()
or .productBatchUpdate()
(method) Woo.productBatch(data: object): object
(method) Woo.productBatchUpdate(data: object): object
Batch create, update and delete multiple products.
Example:
const data = {
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",
},
],
},
{
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",
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg",
},
],
},
],
update: [
{
id: 799,
default_attributes: [
{
id: 6,
name: "Color",
option: "Green",
},
{
id: 0,
name: "Size",
option: "M",
},
],
},
],
delete: [794],
};
woo
.productBatch(data)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.log(error);
});
Attribute | Type | Description |
---|---|---|
id |
integer | Variation ID. READ-ONLY |
date_created |
date-time | The date the variation was created, in the site's timezone. READ-ONLY |
date_created_gmt |
date-time | The date the variation was created, as GMT. READ-ONLY |
date_modified |
date-time | The date the variation was last modified, in the site's timezone. READ-ONLY |
date_modified_gmt |
date-time | The date the variation was last modified, as GMT. READ-ONLY |
description |
string | Variation description. |
permalink |
string | Variation URL. READ-ONLY |
sku |
string | Unique identifier. |
price |
string | Current variation price. READ-ONLY |
regular_price |
string | Variation regular price. |
sale_price |
string | Variation sale price. |
date_on_sale_from |
date-time | Start date of sale price, in the site's timezone. |
date_on_sale_from_gmt |
date-time | Start date of sale price, as GMT. |
date_on_sale_to |
date-time | End data of sale price, in the site's timezone. |
date_on_sale_to_gmt |
date-time | End data of sale price, as GMT. |
on_sale |
boolean | Shows if the variation is on sale. READ-ONLY |
status |
string | Variation status. Options: draft , pending , private and publish . Default is publish . |
purchasable |
boolean | Shows if the variation can be bought. READ-ONLY |
virtual |
boolean | If the variation is virtual. Default is false . |
downloadable |
boolean | If the variation is downloadable. Default is false . |
downloads |
array | List of downloadable files. See Product variation - Downloads properties. |
download_limit |
integer | Number of times downloadable files can be downloaded after purchase. Default is -1 . |
download_expiry |
integer | Number of days until access to downloadable files expires. Default is -1 . |
tax_status |
string | Tax status. Options: taxable , shipping and none . Default is taxable . |
tax_class |
string | Tax class. |
manage_stock |
boolean | Stock management at variation level. Default is false . |
stock_quantity |
integer | Stock quantity. |
stock_status |
string | Controls the stock status of the product. Options: instock , outofstock , onbackorder . Default is instock . |
backorders |
string | If managing stock, this controls if backorders are allowed. Options: no , notify and yes . Default is no . |
backorders_allowed |
boolean | Shows if backorders are allowed. READ-ONLY |
backordered |
boolean | Shows if the variation is on backordered. READ-ONLY |
weight |
string | Variation weight. |
dimensions |
object | Variation dimensions. See Product variation - Dimensions properties. |
shipping_class |
string | Shipping class slug. |
shipping_class_id |
string | Shipping class ID. READ-ONLY |
image |
object | Variation image data. See Product variation - Image properties. |
attributes |
array | List of attributes. See Product variation - Attributes properties. |
menu_order |
integer | Menu order, used to custom sort products. |
meta_data |
array | Meta data. See Product variation - Meta data properties. |
Attribute | Type | Description |
---|---|---|
id |
string | File ID. |
name |
string | File name. |
file |
string | File URL. |
Attribute | Type | Description |
---|---|---|
length |
string | Variation length. |
width |
string | Variation width. |
height |
string | Variation height. |
Attribute | Type | Description |
---|---|---|
id |
integer | Image ID. |
date_created |
date-time | The date the image was created, in the site's timezone. READ-ONLY |
date_created_gmt |
date-time | The date the image was created, as GMT. READ-ONLY |
date_modified |
date-time | The date the image was last modified, in the site's timezone. READ-ONLY |
date_modified_gmt |
date-time | The date the image was last modified, as GMT. READ-ONLY |
src |
string | Image URL. |
name |
string | Image name. |
alt |
string | Image alternative text. |
Attribute | Type | Description |
---|---|---|
id |
integer | Attribute ID. |
name |
string | Attribute name. |
option |
string | Selected attribute term name. |
Attribute | Type | Description |
---|---|---|
id |
integer | Meta ID. READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
.variationCreate()
or .variationAdd()
(method) Woo.variationCreate(productID: number, data: object): object
(method) Woo.variationAdd(productID: number, data: object): object
Create a new variation.
Example:
const data = {
regular_price: "9.00",
image: {
id: 423
},
attributes: [
{
id: 9,
option: "Black"
}
]
};
woo.
.variationCreate( 56, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.variationRetrieve()
or .variationGet()
(method) Woo.variationRetrieve(productID: number, variationID: number): object
(method) Woo.variationGet(productID: number, variationID: number): object
Retrieve and view a specific product variation by ID.
Example:
woo.
.variationRetrieve( 56, 57 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.variationList()
or .variationGetAll()
(method) Woo.variationList(productID: number, params?: object): object
(method) Woo.variationGetAll(productID: number, params?: object): object
View all the product variations.
Example:
woo.
.variationList( 56 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . Maximum is 100 . |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is desc . |
orderby |
string | Sort collection by object attribute. Options: date , id , include , title and slug . Default is date . |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
slug |
string | Limit result set to products with a specific slug. |
status |
string | Limit result set to products assigned a specific status. Options: any , draft , pending , private and publish . Default is any . |
sku |
string | Limit result set to products with a specific SKU. |
tax_class |
string | Limit result set to products with a specific tax class. Default options: standard , reduced-rate and zero-rate . |
on_sale |
boolean | Limit result set to products on sale. |
min_price |
string | Limit result set to products based on a minimum price. |
max_price |
string | Limit result set to products based on a maximum price. |
stock_status |
string | Limit result set to products with specified stock status. Options: instock , outofstock and onbackorder . |
.variationUpdate()
or .variationEdit()
(method) Woo.variationUpdate(productID: number, variationID: number, data: object): object
(method) Woo.variationEdit(productID: number, variationID: number, data: object): object
Make changes to a product variation.
Example:
const data = {
regular_price: "9.00",
image: {
id: 423
},
attributes: [
{
id: 9,
option: "Black"
}
]
};
woo.
.variationUpdate( 56, 57, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.variationDelete()
or .variationRemove()
(method) Woo.variationDelete(productID: number, variationID: number, params?: object): object
(method) Woo.variationRemove(productID: number, variationID: number, params?: object): object
Delete a product variation.
Example:
woo.
.variationDelete( 56, 57 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.variationBatch()
or .variationBatchUpdate()
(method) Woo.variationBatch(productID: number, data: object): object
(method) Woo.variationBatchUpdate(productID: number, data: object): object
Batch create, update and delete multiple product variations.
Example:
const data = {
create: [
{
regular_price: "9.00",
image: {
id: 423
},
attributes: [
{
id: 9,
option: "Black"
}
]
}
],
update: [
{
id: 57,
regular_price: "9.00",
image: {
id: 423
},
attributes: [
{
id: 9,
option: "Black"
}
]
}
],
delete: [ 58 ]
};
woo.
.variationBatch( 56, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Attribute | Type | Description |
---|---|---|
id |
number | Unique identifier for the resource. READ-ONLY |
name |
string | Attribute name. MANDATORY |
slug |
string | An alphanumeric identifier for the resource unique to its type. |
type |
string | Type of attribute. By default only select is supported. |
order_by |
string | Default sort order. Options: menu_order , name , name_num and id . Default is menu_order . |
has_archives |
boolean | Enable/Disable attribute archives. Default is false . |
.attributeCreate()
or .attributeAdd()
(method) Woo.attributeCreate(data: object): object
(method) Woo.attributeAdd(data: object): object
Create a new product attribute.
Example:
const data = {
name: "Color",
type: "select",
order_by: "menu_order",
has_archives: true
};
woo.
.attributeCreate( data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.attributeRetrieve()
or .attributeGet()
(method) Woo.attributeRetrieve(id: number): object
(method) Woo.attributeGet(id: number): object
Retrieve a product attribute.
Example:
woo.
.attributeRetrieve( 9 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.attributeList()
or .attributeGetAll()
(method) Woo.attributeList(params?: object): object
(method) Woo.attributeGetAll(params?: object): object
View all the product attributes.
Example:
woo.
.attributeList()
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
.attributeUpdate()
or .attributeEdit()
(method) Woo.attributeUpdate(id: number, data: object): object
(method) Woo.attributeEdit(id: number, data: object): object
Make changes to a product attribute.
Example:
const data = {
name: "Color",
type: "select",
order_by: "menu_order",
has_archives: true
};
woo.
.attributeUpdate( 9, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
This also will delete all terms from the selected attribute.
.attributeDelete()
or .attributeRemove()
(method) Woo.attributeDelete(id: number, params?: object): object
(method) Woo.attributeRemove(id: number, params?: object): object
Delete a product attribute.
Example:
woo.
.attributeDelete( 9, { force: true } )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.attributeBatch()
or .attributeBatchUpdate()
(method) Woo.attributeBatch(data: object): object
(method) Woo.attributeBatchUpdate(data: object): object
Batch create, update and delete multiple product attributes.
Example:
const data = {
create: [
{
name: "Color",
type: "select",
order_by: "menu_order",
has_archives: true
}
],
update: [
{
id: 9,
name: "Color",
type: "select",
order_by: "menu_order",
has_archives: true
}
],
delete: [ 10 ]
};
woo.
.attributeBatch( data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
name |
string | Term name. MANDATORY |
slug |
string | An alphanumeric identifier for the resource unique to its type. |
description |
string | HTML description of the resource. |
menu_order |
integer | Menu order, used to custom sort the terms. |
count |
integer | Number of published products for the resource. READ-ONLY |
.termCreate()
or .termAdd()
(method) Woo.termCreate(attributeID: number, data: object): object
(method) Woo.termAdd(attributeID: number, data: object): object
Create a new product attribute term.
Example:
const data = {
name: "Blue",
slug: "blue"
};
woo.
.termCreate( 9, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.termRetrieve()
or .termGet()
(method) Woo.termRetrieve(attributeID: number, termID: number): object
(method) Woo.termGet(attributeID: number, termID: number): object
Retrieve a product attribute term by ID.
Example:
woo.
.termRetrieve( 9, 10 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.termList()
or .termGetAll()
(method) Woo.termList(attributeID: number, params?: object): object
(method) Woo.termGetAll(attributeID: number, params?: object): object
Retrieve all terms from a product attribute.
Example:
woo.
.termList( 9 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is asc . |
orderby |
string | Sort collection by resource attribute. Options: id , include , name , slug , term_group , description and count . Default is name . |
hide_empty |
boolean | Whether to hide resources not assigned to any products. Default is false . |
parent |
integer | Limit result set to resources assigned to a specific parent. |
product |
integer | Limit result set to resources assigned to a specific product. |
slug |
string | Limit result set to resources with a specific slug. |
.termUpdate()
or .termEdit()
(method) Woo.termUpdate(attributeID: number, termID: number): object
(method) Woo.termEdit(attributeID: number, termID: number): object
Make changes to a product attribute term.
Example:
const data = {
name: "Blue",
slug: "blue"
};
woo.
.termUpdate( 9, 10, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.termDelete()
or .termRemove()
(method) Woo.termDelete(attributeID: number, termID: number, params?: object): object
(method) Woo.termRemove(attributeID: number, termID: number, params?: object): object
Delete a product attribute term.
Example:
woo.
.termDelete( 9, 10, { force: true } )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.termBatch()
or .termBatchUpdate()
(method) Woo.termBatch(attributeID: number, data: object): object
(method) Woo.termBatchUpdate(attributeID: number, data: object): object
Batch create, update and delete multiple product attribute terms.
Example:
const data = {
create: [
{
name: "Blue",
slug: "blue"
},
{
name: "Green",
slug: "green"
}
],
update: [
{
id: 10,
name: "Blue",
slug: "blue"
}
],
delete: [ 11 ]
};
woo.
.termBatch( 9, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Attribute | Type | Description |
---|---|---|
id |
number | Unique identifier for the resource. READ-ONLY |
name |
string | Category name. MANDATORY |
slug |
string | An alphanumeric identifier for the resource unique to its type. |
parent |
integer | The ID for the parent of the resource. |
description |
string | HTML description of the resource. |
display |
string | Category archive display type. Options: default , products , subcategories and both . Default is default . |
image |
object | Image data. See Product category - Image properties |
menu_order |
integer | Menu order, used to custom sort the resources. |
count |
integer | Number of published products for the resource. READ-ONLY |
Attribute | Type | Description |
---|---|---|
id |
number | Image ID. |
date_created |
date-time | The date the image was created, in the site's timezone. READ-ONLY |
date_created_gmt |
date-time | The date the image was created, as GMT. READ-ONLY |
date_modified |
date-time | The date the image was last modified, in the site's timezone. READ-ONLY |
date_modified_gmt |
date-time | The date the image was last modified, as GMT. READ-ONLY |
src |
string | Image URL. |
name |
string | Image name. |
alt |
string | Image alternative text. |
.categoryCreate()
or .categoryAdd()
(method) Woo.categoryCreate(data: object): object
(method) Woo.categoryAdd(data: object): object
Create a product category.
Example:
const data = {
name: "Clothing",
slug: "clothing"
};
woo.
.categoryCreate( data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.categoryRetrieve()
or .categoryGet()
(method) Woo.categoryRetrieve(id: number): object
(method) Woo.categoryGet(id: number): object
Retrieve a product category.
Example:
woo.
.categoryRetrieve( 9 )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.categoryList()
or .categoryGetAll()
(method) Woo.categoryList(params?: object): object
(method) Woo.categoryGetAll(params?: object): object
List all product categories.
Example:
woo.
.categoryList()
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is asc . |
orderby |
string | Sort collection by resource attribute. Options: id , include , name , slug , term_group , description and count . Default is name . |
hide_empty |
boolean | Whether to hide resources not assigned to any products. Default is false . |
parent |
integer | Limit result set to resources assigned a specific parent. |
product |
integer | Limit result set to resources assigned a specific product. |
slug |
string | Limit result set to resources with a specific slug. |
.categoryUpdate()
or .categoryEdit()
(method) Woo.categoryUpdate(id: number, data: object): object
(method) Woo.categoryEdit(id: number, data: object): object
Update a product category.
Example:
const data = {
name: "Clothing",
slug: "clothing"
};
woo.
.categoryUpdate( 9, data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
.categoryDelete()
or .categoryRemove()
(method) Woo.categoryDelete(id: number, params?: object): object
(method) Woo.categoryRemove(id: number, params?: object): object
Delete a product category.
Example:
woo.
.categoryDelete( 9, { force: true } )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.categoryBatch()
or .categoryBatchUpdate()
(method) Woo.categoryBatch(data: object): object
(method) Woo.categoryBatchUpdate(data: object): object
Batch create, update and delete multiple product categories.
Example:
const data = {
create: [
{
name: "Clothing",
slug: "clothing"
}
],
update: [
{
id: 9,
name: "Clothing",
slug: "clothing"
}
],
delete: [ 10 ]
};
woo.
.categoryBatch( data )
.then( response => {
console.log( response );
} )
.catch( error => {
console.log( error );
} );
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
name |
string | Shipping class name. MANDATORY |
slug |
string | An alphanumeric identifier for the resource unique to its type. |
description |
string | HTML description of the resource. |
count |
integer | Number of published products for the resource. READ-ONLY |
.shippingClassCreate()
or .shippingClassAdd()
.shippingClassRetrieve()
or .shippingClassGet()
.shippingClassList()
or .shippingClassGetAll()
Parameter | Type | Description |
---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit . Default is view . |
page |
integer | Current page of the collection. Default is 1 . |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10 . |
search |
string | Limit results to those matching a string. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc . Default is asc . |
orderby |
string | Sort collection by resource attribute. Options: id , include , name , slug , term_group , description and count . Default is name . |
hide_empty |
boolean | Whether to hide resources not assigned to any products. Default is false . |
product |
integer | Limit result set to resources assigned a specific product. |
slug |
string | Limit result set to resources with a specific slug. |
.shippingClassUpdate()
or .shippingClassEdit()
.shippingClassDelete()
or .shippingClassRemove()
Parameter | Type | Description |
---|---|---|
force |
boolean | Required to be true , as resource does not support trashing. |
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
.shippingClassBatch()
or .shippingClassBatchUpdate()