woojs v1.0.4

wooJS

JavaScript Library for WooCommerce REST API

Extends @woocommerce/woocommerce-rest-api with more descriptive methods.

Table of Contents

• Installation
• Usage
  • Constructor Parameters
  • Options
• Coupons
  • Coupon Properties
    • Coupon Meta Data Properties
  • Methods
    • Create Coupon
    • Retrieve Coupon
    • List Coupons
      • List Coupons Parameters
    • Update Coupon
    • Delete Coupon
      • Delete Coupon Parameters
    • Batch Update Coupons
• Customers
  • Customer Properties
    • Customer Billing Properties
    • Customer Shipping Properties
    • Customer Meta Data Properties
  • Methods
    • Create Customer
    • Retrieve Customer
    • List Customers
      • List Customers Parameters
    • Update Customer
    • Delete Customer
      • Delete Customer Parameters
    • Batch Update Customers
    • Retrieve Customer Downloads
• Orders
  • Order properties
    • Order - Billing properties
    • Order - Shipping properties
    • Order - Meta Data properties
    • Order - Line items properties
    • Order - Tax lines properties
    • Order - Shipping lines properties
    • Order - Fee lines properties
    • Order - Coupon lines properties
    • Order - Refunds properties
    • Order - Taxes properties
  • Order Methods
    • Create Order
    • Retrieve Order
    • List Orders
      • List Orders Parameters
    • Update Order
    • Delete Order
      • Delete Order Parameters
    • Batch Update Orders
• Order Notes
  • Order Notes Properties
  • Order Notes Methods
    • Create Order Note
    • Retrieve Order Note
    • List All Order Notes
      • List All Order Notes Parameters
    • Delete Order Note
      • Delete Order Note Parameters
• Order Refunds
  • Order Refunds Properties
  • Order Refunds Methods
    • Create Order Refund
    • Retrieve Order Refund
    • List All Order Refunds
      • List All Order Refunds Parameters
    • Delete Order Refund
      • Delete Order Refund Parameters
• Products
  • Products properties
  • Products methods
    • Create Product
    • Retrieve Product
    • List Products
      • List Products Parameters
    • Update Product
    • Delete Product
      • Delete Product Parameters
    • Batch Update Products
• Product Variations
  • Product Variations Properties
    • Product Variation - Meta Data Properties
    • Product Variation - Dimensions Properties
    • Product Variation - Image Properties
    • Product Variation - Attributes Properties
    • Product Variation - Meta data Properties
  • Product Variations Methods
    • Create Product Variation
    • Retrieve Product Variation
    • List Product Variations
      • List Product Variations Parameters
    • Update Product Variation
    • Delete Product Variation
      • Delete Product Variation Parameters
    • Batch Update Product Variations
• Product Attributes
  • Product Attributes Properties
  • Product Attributes Methods
    • Create Product Attribute
    • Retrieve Product Attribute
    • List Product Attributes
      • List Product Attributes Parameters
    • Update Product Attribute
    • Delete Product Attribute
      • Delete Product Attribute Parameters
    • Batch Update Product Attributes
• Product Attribute Terms
  • Product Attribute Terms Properties
  • Product Attribute Terms Methods
    • Create Product Attribute Term
    • Retrieve Product Attribute Term
    • List Product Attribute Terms
      • List Product Attribute Terms Parameters
    • Update Product Attribute Term
    • Delete Product Attribute Term
      • Delete Product Attribute Term Parameters
    • Batch Update Product Attribute Terms
• Product Categories
  • Product Categories Properties
    • Product category - Image properties
  • Product Categories Methods
    • Create Product Category
    • Retrieve Product Category
    • List Product Categories
      • List Product Categories Parameters
    • Update Product Category
    • Delete Product Category
      • Delete Product Category Parameters
    • Batch Update Product Categories

Installation

npm i woojs

Usage

const Woo = require("woojs");
const woo = new Woo(url, consumerKey, consumerSecret);

How to generate REST API keys

Constructor Parameters

Woo(url, key, secret {options})

Options

Coupons

Coupon Properties

Coupon - Meta Data Properties

Coupon Methods

Create Coupon

.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);
  });

data props

Retrieve Coupon

.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);
  });

List Coupons

.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);
  });

List Coupons parameters:

Update Coupon

.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);
  });

data props

Delete Coupon

.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);
  });

Delete Coupon parameters:

Batch Update Coupons

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);
  });

Customers

Customer properties

Customer - Billing Properties

Customer - Shipping Properties

Customer - Meta data properties

Customer methods

Create Customer

.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);
  });

Retrieve Customer

.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);
  });

List Customers

.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);
  });

List Customers parameters

Update 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);
  });

data options

Delete Customer

.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);
  });

Delete Customer parameters

Batch Update Customers

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);
  });

data options

Retrieve Customer Downloads

.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);
  });

Orders

Order properties