WooCommerce connection for LinkyFlow

LinkyFlow brings WooCommerce ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

218

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Analytics

Coupon Totals

Coupon counts grouped by type.

Read

Coupon Totals

Coupon counts grouped by type.

Route: GET /reportCouponsTotals

Excel formula: =LF.woocommerce.reportCouponsTotals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-
`total` default	number	—	-

Customer Totals

Customer counts grouped by type.

Read

Customer Totals

Customer counts grouped by type.

Route: GET /reportCustomersTotals

Excel formula: =LF.woocommerce.reportCustomersTotals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-
`total` default	number	—	-

Order Totals

Order counts grouped by status.

Read

Order Totals

Order counts grouped by status.

Route: GET /reportOrdersTotals

Excel formula: =LF.woocommerce.reportOrdersTotals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-
`total` default	number	—	-

Product Totals

Product counts grouped by type.

Read

Product Totals

Product counts grouped by type.

Route: GET /reportProductsTotals

Excel formula: =LF.woocommerce.reportProductsTotals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-
`total` default	number	—	-

Review Totals

Review counts grouped by status.

Read

Review Totals

Review counts grouped by status.

Route: GET /reportReviewsTotals

Excel formula: =LF.woocommerce.reportReviewsTotals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-
`total` default	number	—	-

Sales Report

Summary sales report for a date range.

Read

Sales Report

Summary sales report for a date range.

Route: GET /reportSales

Excel formula: =LF.woocommerce.reportSales("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`date_min`	date	No	-
`date_max`	date	No	-

Data returned in Excel

Field	Type	Relations	Description
`average_sales` default	number	—	-
`net_revenue` default	number	—	-
`total_customers` default	number	—	-
`total_items` default	number	—	-
`total_orders` default	number	—	-
`total_sales` default	number	—	-

Top Sellers

Top-selling products by quantity.

Read

Top Sellers

Top-selling products by quantity.

Route: GET /reportTopSellers

Excel formula: =LF.woocommerce.reportTopSellers("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`date_min`	date	No	-
`date_max`	date	No	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`product_id` default	id	→ products	-
`quantity` default	number	—	-
`total` default	number	—	-

Catalog

Attribute Terms

Terms (values) belonging to a product attribute.

Read

Attribute Terms

Terms (values) belonging to a product attribute.

Route: GET /productAttributeTerms

Excel formula: =LF.woocommerce.productAttributeTerms("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`attribute_id`	id	Yes	Parent attribute ID
`search`	string	No	Filter by keyword
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`count` default	number	—	-
`description`	string	—	-
`id` default	id	—	-
`menu_order`	number	—	-
`name` default	string	—	-
`slug` default	string	—	-

Create

Create Term

Route: POST /mutation/productAttributeTerms

Inputs you can set

Name	Type	Required	Description
`attribute_id`	id	Yes	-
`description`	string	No	-
`menu_order`	number	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Term

Route: PATCH /mutation/productAttributeTerms

Inputs you can set

Name	Type	Required	Description
`attribute_id`	id	Yes	-
`description`	string	No	-
`menu_order`	number	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Term

Route: DELETE /mutation/productAttributeTerms

Inputs you can set

Name	Type	Required	Description
`attribute_id`	id	Yes	-
`description`	string	No	-
`menu_order`	number	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Attributes

Global product attributes (color, size, etc.).

Read

Product Attributes

Global product attributes (color, size, etc.).

Route: GET /productAttributes

Excel formula: =LF.woocommerce.productAttributes("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`has_archives`	boolean	—	-
`id` default	id	—	-
`name` default	string	—	-
`order_by`	enum	—	-
`slug` default	string	—	-
`type`	string	—	-

Create

Create Attribute

Route: POST /mutation/productAttributes

Inputs you can set

Name	Type	Required	Description
`has_archives`	boolean	No	-
`name`	string	Yes	-
`order_by`	enum	No	Values: menu_order, name, name_num, id
`slug`	string	No	-
`type`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Attribute

Route: PATCH /mutation/productAttributes

Inputs you can set

Name	Type	Required	Description
`has_archives`	boolean	No	-
`name`	string	Yes	-
`order_by`	enum	No	Values: menu_order, name, name_num, id
`slug`	string	No	-
`type`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Attribute

Route: DELETE /mutation/productAttributes

Inputs you can set

Name	Type	Required	Description
`has_archives`	boolean	No	-
`name`	string	Yes	-
`order_by`	enum	No	Values: menu_order, name, name_num, id
`slug`	string	No	-
`type`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Brands

Product brands in your store.

Read

Product Brands

Product brands in your store.

Route: GET /brands

Excel formula: =LF.woocommerce.brands("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`search`	string	No	Filter by keyword
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`count` default	number	—	-
`description`	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`slug` default	string	—	-

Create

Create Brand

Route: POST /mutation/brands

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Brand

Route: PATCH /mutation/brands

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Brand

Route: DELETE /mutation/brands

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Categories

Product categories in your store.

Read

Product Categories

Product categories in your store.

Route: GET /categories

Excel formula: =LF.woocommerce.categories("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`search`	string	No	Filter by keyword
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`count` default	number	—	-
`description`	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`parent`	id	→ categories	-
`slug` default	string	—	-

Create

Create Category

Route: POST /mutation/categories

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`parent`	id	No	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Category

Route: PATCH /mutation/categories

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`parent`	id	No	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Category

Route: DELETE /mutation/categories

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`parent`	id	No	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Reviews

Customer reviews on products.

Read

Product Reviews

Customer reviews on products.

Route: GET /productReviews

Excel formula: =LF.woocommerce.productReviews("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`product`	id	No	Filter by product ID
`status`	enum	No	Default: approved Values: all, hold, approved, spam, trash
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`date_created` default	date	—	-
`id` default	id	—	-
`product_id` default	id	→ products	-
`rating` default	number	—	-
`review` default	string	—	-
`reviewer` default	string	—	-
`status` default	string	—	-

Create

Create Review

Route: POST /mutation/productReviews

Inputs you can set

Name	Type	Required	Description
`product_id`	id	Yes	-
`rating`	number	No	-
`review`	string	Yes	-
`reviewer`	string	Yes	-
`reviewer_email`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Review

Route: PATCH /mutation/productReviews

Inputs you can set

Name	Type	Required	Description
`product_id`	id	Yes	-
`rating`	number	No	-
`review`	string	Yes	-
`reviewer`	string	Yes	-
`reviewer_email`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Review

Route: DELETE /mutation/productReviews

Inputs you can set

Name	Type	Required	Description
`product_id`	id	Yes	-
`rating`	number	No	-
`review`	string	Yes	-
`reviewer`	string	Yes	-
`reviewer_email`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Tags

Product tags in your store.

Read

Product Tags

Product tags in your store.

Route: GET /tags

Excel formula: =LF.woocommerce.tags("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`search`	string	No	Filter by keyword
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`count` default	number	—	-
`description`	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`slug` default	string	—	-

Create

Create Tag

Route: POST /mutation/tags

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Tag

Route: PATCH /mutation/tags

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Tag

Route: DELETE /mutation/tags

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Variations

Variations (size, color, etc.) for variable products.

Read

Product Variations

Variations (size, color, etc.) for variable products.

Route: GET /productVariations

Excel formula: =LF.woocommerce.productVariations("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`product_id`	id	Yes	Parent product ID
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`date_created` default	date	—	-
`id` default	id	—	-
`price` default	number	—	-
`sku` default	string	—	-
`status` default	string	—	-
`stock_quantity` default	number	—	-
`stock_status` default	string	—	-

Create

Create Variation

Route: POST /mutation/productVariations

Inputs you can set

Name	Type	Required	Description
`manage_stock`	boolean	No	-
`product_id`	id	Yes	-
`regular_price`	number	No	-
`sale_price`	number	No	-
`sku`	string	No	-
`stock_quantity`	number	No	-
`stock_status`	enum	No	Values: instock, outofstock, onbackorder

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Variation

Route: PATCH /mutation/productVariations

Inputs you can set

Name	Type	Required	Description
`manage_stock`	boolean	No	-
`product_id`	id	Yes	-
`regular_price`	number	No	-
`sale_price`	number	No	-
`sku`	string	No	-
`stock_quantity`	number	No	-
`stock_status`	enum	No	Values: instock, outofstock, onbackorder

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Variation

Route: DELETE /mutation/productVariations

Inputs you can set

Name	Type	Required	Description
`manage_stock`	boolean	No	-
`product_id`	id	Yes	-
`regular_price`	number	No	-
`sale_price`	number	No	-
`sku`	string	No	-
`stock_quantity`	number	No	-
`stock_status`	enum	No	Values: instock, outofstock, onbackorder

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Products

Products in your WooCommerce store.

Used as filter by

Product Reviews · product

Product Variations · product_id

Read

Products

Products in your WooCommerce store.

Route: GET /products

Excel formula: =LF.woocommerce.products("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`status`	enum	No	Filter by product status Values: any, publish, draft, pending, private
`category`	string	No	Filter by category slug or ID
`search`	string	No	Filter by keyword
`sku`	string	No	Filter by exact SKU
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`date_created` default	date	—	-
`id` default	id	—	-
`name` default	string	—	-
`price` default	number	—	-
`regular_price` default	number	—	-
`sku` default	string	—	-
`status` default	enum	—	-
`stock_quantity` default	number	—	-
`stock_status` default	enum	—	-

Create

Create Product

Route: POST /mutation/products

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`manage_stock`	boolean	No	-
`name`	string	Yes	-
`regular_price`	number	No	-
`sale_price`	number	No	-
`short_description`	string	No	-
`sku`	string	No	-
`status`	enum	No	Values: publish, draft, pending, private
`stock_quantity`	number	No	-
`stock_status`	enum	No	Values: instock, outofstock, onbackorder
`type`	enum	No	Values: simple, grouped, external, variable
`weight`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Route: PATCH /mutation/products

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`manage_stock`	boolean	No	-
`name`	string	Yes	-
`regular_price`	number	No	-
`sale_price`	number	No	-
`short_description`	string	No	-
`sku`	string	No	-
`status`	enum	No	Values: publish, draft, pending, private
`stock_quantity`	number	No	-
`stock_status`	enum	No	Values: instock, outofstock, onbackorder
`type`	enum	No	Values: simple, grouped, external, variable
`weight`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Product

Route: DELETE /mutation/products

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`manage_stock`	boolean	No	-
`name`	string	Yes	-
`regular_price`	number	No	-
`sale_price`	number	No	-
`short_description`	string	No	-
`sku`	string	No	-
`status`	enum	No	Values: publish, draft, pending, private
`stock_quantity`	number	No	-
`stock_status`	enum	No	Values: instock, outofstock, onbackorder
`type`	enum	No	Values: simple, grouped, external, variable
`weight`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Shipping Classes

Product shipping classes.

Read

Shipping Classes

Product shipping classes.

Route: GET /shippingClasses

Excel formula: =LF.woocommerce.shippingClasses("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`search`	string	No	Filter by keyword
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`count` default	number	—	-
`description`	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`slug` default	string	—	-

Create

Create Shipping Class

Route: POST /mutation/shippingClasses

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Shipping Class

Route: PATCH /mutation/shippingClasses

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Shipping Class

Route: DELETE /mutation/shippingClasses

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`name`	string	Yes	-
`slug`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customers

Store customers.

Used as filter by

Orders · customer

Read

Customers

Store customers.

Route: GET /customers

Excel formula: =LF.woocommerce.customers("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`role`	enum	No	Default: customer Values: all, administrator, editor, customer, subscriber
`search`	string	No	Filter by keyword
`email`	string	No	Filter by email
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`date_created` default	date	—	-
`email` default	string	—	-
`first_name` default	string	—	-
`id` default	id	—	-
`last_name` default	string	—	-
`orders_count` default	number	—	-
`total_spent` default	number	—	-

Create

Create Customer

Route: POST /mutation/customers

Inputs you can set

Name	Type	Required	Description
`email`	string	Yes	-
`first_name`	string	No	-
`last_name`	string	No	-
`password`	string	No	-
`username`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer

Route: PATCH /mutation/customers

Inputs you can set

Name	Type	Required	Description
`email`	string	Yes	-
`first_name`	string	No	-
`last_name`	string	No	-
`password`	string	No	-
`username`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Customer

Route: DELETE /mutation/customers

Inputs you can set

Name	Type	Required	Description
`email`	string	Yes	-
`first_name`	string	No	-
`last_name`	string	No	-
`password`	string	No	-
`username`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Marketing

Coupons

Discount coupons.

Read

Coupons

Discount coupons.

Route: GET /coupons

Excel formula: =LF.woocommerce.coupons("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`search`	string	No	Filter by keyword
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`code` default	string	—	-
`date_created` default	date	—	-
`date_expires` default	date	—	-
`discount_type` default	enum	—	-
`id` default	id	—	-
`usage_count` default	number	—	-

Create

Create Coupon

Route: POST /mutation/coupons

Inputs you can set

Name	Type	Required	Description
`amount`	number	No	-
`code`	string	Yes	-
`date_expires`	date	No	-
`discount_type`	enum	Yes	Values: percent, fixed_cart, fixed_product
`individual_use`	boolean	No	-
`minimum_amount`	number	No	-
`usage_limit`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Coupon

Route: PATCH /mutation/coupons

Inputs you can set

Name	Type	Required	Description
`amount`	number	No	-
`code`	string	Yes	-
`date_expires`	date	No	-
`discount_type`	enum	Yes	Values: percent, fixed_cart, fixed_product
`individual_use`	boolean	No	-
`minimum_amount`	number	No	-
`usage_limit`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Coupon

Route: DELETE /mutation/coupons

Inputs you can set

Name	Type	Required	Description
`amount`	number	No	-
`code`	string	Yes	-
`date_expires`	date	No	-
`discount_type`	enum	Yes	Values: percent, fixed_cart, fixed_product
`individual_use`	boolean	No	-
`minimum_amount`	number	No	-
`usage_limit`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Sales

Order Notes

Notes attached to orders.

Read

Order Notes

Notes attached to orders.

Route: GET /orderNotes

Excel formula: =LF.woocommerce.orderNotes("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`order_id`	id	Yes	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`author` default	string	—	-
`customer_note` default	boolean	—	-
`date_created` default	date	—	-
`id` default	id	—	-
`note` default	string	—	-

Create

Create Order Note

Route: POST /mutation/orderNotes

Inputs you can set

Name	Type	Required	Description
`customer_note`	boolean	No	-
`note`	string	Yes	-
`order_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Order Note

Route: DELETE /mutation/orderNotes

Inputs you can set

Name	Type	Required	Description
`customer_note`	boolean	No	-
`note`	string	Yes	-
`order_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Order Statuses

Order statuses available in the store.

Read

Order Statuses

Order statuses available in the store.

Route: GET /orderStatuses

Excel formula: =LF.woocommerce.orderStatuses("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-

Orders

Customer orders in your WooCommerce store.

Used as filter by

Order Notes · order_id

Refunds · order_id

Read

Orders

Customer orders in your WooCommerce store.

Route: GET /orders

Excel formula: =LF.woocommerce.orders("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`status`	enum	No	Filter by order status Values: any, pending, processing, on-hold, completed
`customer`	id	No	Filter by customer ID
`after`	date	No	Orders created after this date
`before`	date	No	Orders created before this date
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`email` default	string	—	-
`first_name` default	string	—	-
`last_name` default	string	—	-
`customer_id` default	id	→ customers	-
`date_created` default	date	—	-
`id` default	id	—	-
`number` default	string	—	-
`status` default	string	—	-
`total` default	number	—	-

Create

Create Order

Route: POST /mutation/orders

Inputs you can set

Name	Type	Required	Description
`billing.email`	string	No	-
`billing.first_name`	string	No	-
`billing.last_name`	string	No	-
`billing.phone`	string	No	-
`customer_id`	id	No	-
`payment_method`	string	No	-
`status`	enum	No	Values: pending, processing, on-hold, completed

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Order

Route: PATCH /mutation/orders

Inputs you can set

Name	Type	Required	Description
`billing.email`	string	No	-
`billing.first_name`	string	No	-
`billing.last_name`	string	No	-
`billing.phone`	string	No	-
`customer_id`	id	No	-
`payment_method`	string	No	-
`status`	enum	No	Values: pending, processing, on-hold, completed

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Order

Route: DELETE /mutation/orders

Inputs you can set

Name	Type	Required	Description
`billing.email`	string	No	-
`billing.first_name`	string	No	-
`billing.last_name`	string	No	-
`billing.phone`	string	No	-
`customer_id`	id	No	-
`payment_method`	string	No	-
`status`	enum	No	Values: pending, processing, on-hold, completed

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Refunds

Refunds applied to orders.

Read

Refunds

Refunds applied to orders.

Route: GET /refunds

Excel formula: =LF.woocommerce.refunds("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`order_id`	id	Yes	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`date_created` default	date	—	-
`id` default	id	—	-
`reason` default	string	—	-
`refunded_by`	id	—	-

Create

Create Refund

Route: POST /mutation/refunds

Inputs you can set

Name	Type	Required	Description
`amount`	number	Yes	-
`order_id`	id	Yes	-
`reason`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Refund

Route: DELETE /mutation/refunds

Inputs you can set

Name	Type	Required	Description
`amount`	number	Yes	-
`order_id`	id	Yes	-
`reason`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Settings

Continents

Continents and the countries they contain.

Read

Continents

Continents and the countries they contain.

Route: GET /dataContinents

Excel formula: =LF.woocommerce.dataContinents("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`code` default	string	—	-
`name` default	string	—	-

Countries

Countries supported by the store.

Read

Countries

Countries supported by the store.

Route: GET /dataCountries

Excel formula: =LF.woocommerce.dataCountries("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`code` default	string	—	-
`name` default	string	—	-

Currencies

Currencies supported by the store.

Read

Currencies

Currencies supported by the store.

Route: GET /dataCurrencies

Excel formula: =LF.woocommerce.dataCurrencies("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`code` default	string	—	-
`name` default	string	—	-
`symbol` default	string	—	-

Payment Gateways

Configured payment gateways.

Read

Payment Gateways

Configured payment gateways.

Route: GET /paymentGateways

Excel formula: =LF.woocommerce.paymentGateways("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`description`	string	—	-
`enabled` default	boolean	—	-
`id` default	id	—	-
`method_title` default	string	—	-
`title` default	string	—	-

Edit

Update Payment Gateway

Route: PATCH /mutation/paymentGateways

Inputs you can set

Name	Type	Required	Description
`description`	string	No	-
`enabled`	boolean	No	-
`id`	string	Yes	-
`title`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Settings Groups

Top-level groups of store settings.

Read

Settings Groups

Top-level groups of store settings.

Route: GET /settingsGroups

Excel formula: =LF.woocommerce.settingsGroups("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`description` default	string	—	-
`id` default	id	—	-
`label` default	string	—	-
`parent_id`	string	—	-

Settings Options

Individual settings within a group (e.g. general, products, tax).

Read

Settings Options

Individual settings within a group (e.g. general, products, tax).

Route: GET /settingsOptions

Excel formula: =LF.woocommerce.settingsOptions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`group_id`	string	Yes	e.g. general, products, tax, shipping, account

Data returned in Excel

Field	Type	Relations	Description
`default`	string	—	-
`description`	string	—	-
`id` default	id	—	-
`label` default	string	—	-
`type`	string	—	-
`value` default	string	—	-

Edit

Update Setting

Route: PATCH /mutation/settingsOptions

Inputs you can set

Name	Type	Required	Description
`group_id`	string	Yes	-
`id`	string	Yes	-
`value`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Shipping Methods

Shipping methods available to assign to zones.

Read

Shipping Methods

Shipping methods available to assign to zones.

Route: GET /shippingMethods

Excel formula: =LF.woocommerce.shippingMethods("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`description` default	string	—	-
`id` default	id	—	-
`title` default	string	—	-

Shipping Zone Locations

Locations covered by a shipping zone.

Read

Shipping Zone Locations

Locations covered by a shipping zone.

Route: GET /shippingZoneLocations

Excel formula: =LF.woocommerce.shippingZoneLocations("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`zone_id`	id	Yes	Parent shipping zone ID

Data returned in Excel

Field	Type	Relations	Description
`code` default	string	—	-
`type` default	string	—	-

Shipping Zone Methods

Shipping methods assigned to a specific zone.

Read

Shipping Zone Methods

Shipping methods assigned to a specific zone.

Route: GET /shippingZoneMethods

Excel formula: =LF.woocommerce.shippingZoneMethods("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`zone_id`	id	Yes	Parent shipping zone ID

Data returned in Excel

Field	Type	Relations	Description
`enabled` default	boolean	—	-
`instance_id` default	id	—	-
`method_id` default	string	—	-
`order`	number	—	-
`title` default	string	—	-

Create

Add Method to Zone

Route: POST /mutation/shippingZoneMethods

Inputs you can set

Name	Type	Required	Description
`method_id`	string	Yes	-
`zone_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Remove Method from Zone

Route: DELETE /mutation/shippingZoneMethods

Inputs you can set

Name	Type	Required	Description
`method_id`	string	Yes	-
`zone_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Shipping Zones

Configured shipping zones.

Read

Shipping Zones

Configured shipping zones.

Route: GET /shippingZones

Excel formula: =LF.woocommerce.shippingZones("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`order`	number	—	-

Create

Create Shipping Zone

Route: POST /mutation/shippingZones

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`order`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Shipping Zone

Route: PATCH /mutation/shippingZones

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`order`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Shipping Zone

Route: DELETE /mutation/shippingZones

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-
`order`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

System Status Tools

Maintenance tools (clear cache, regenerate, etc.).

Read

System Status Tools

Maintenance tools (clear cache, regenerate, etc.).

Route: GET /systemStatusTools

Excel formula: =LF.woocommerce.systemStatusTools("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`action` default	string	—	-
`description` default	string	—	-
`id` default	id	—	-
`name` default	string	—	-

Tax Classes

Tax classes configured in the store.

Read

Tax Classes

Tax classes configured in the store.

Route: GET /taxClasses

Excel formula: =LF.woocommerce.taxClasses("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`name` default	string	—	-
`slug` default	string	—	-

Create

Create Tax Class

Route: POST /mutation/taxClasses

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Tax Class

Route: DELETE /mutation/taxClasses

Inputs you can set

Name	Type	Required	Description
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tax Rates

Tax rates configured in the store.

Read

Tax Rates

Tax rates configured in the store.

Route: GET /taxRates

Excel formula: =LF.woocommerce.taxRates("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`class`	string	No	-
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`class`	string	—	-
`compound`	boolean	—	-
`country` default	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`rate` default	string	—	-
`shipping`	boolean	—	-
`state` default	string	—	-

Create

Create Tax Rate

Route: POST /mutation/taxRates

Inputs you can set

Name	Type	Required	Description
`class`	string	No	-
`country`	string	No	-
`name`	string	No	-
`rate`	string	Yes	-
`state`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Tax Rate

Route: PATCH /mutation/taxRates

Inputs you can set

Name	Type	Required	Description
`class`	string	No	-
`country`	string	No	-
`name`	string	No	-
`rate`	string	Yes	-
`state`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Tax Rate

Route: DELETE /mutation/taxRates

Inputs you can set

Name	Type	Required	Description
`class`	string	No	-
`country`	string	No	-
`name`	string	No	-
`rate`	string	Yes	-
`state`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Webhooks

Webhooks configured in the store.

Read

Webhooks

Webhooks configured in the store.

Route: GET /webhooks

Excel formula: =LF.woocommerce.webhooks("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`status`	enum	No	Default: all Values: all, active, paused, disabled
`per_page`	number	No	Items per page (max 100) Default: 100

Data returned in Excel

Field	Type	Relations	Description
`date_created` default	date	—	-
`delivery_url` default	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`status` default	string	—	-
`topic` default	string	—	-

Create

Create Webhook

Route: POST /mutation/webhooks

Inputs you can set

Name	Type	Required	Description
`delivery_url`	string	Yes	-
`name`	string	No	-
`secret`	string	No	-
`topic`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Webhook

Route: PATCH /mutation/webhooks

Inputs you can set

Name	Type	Required	Description
`delivery_url`	string	Yes	-
`name`	string	No	-
`secret`	string	No	-
`topic`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Webhook

Route: DELETE /mutation/webhooks

Inputs you can set

Name	Type	Required	Description
`delivery_url`	string	Yes	-
`name`	string	No	-
`secret`	string	No	-
`topic`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.