BigCommerce connection for LinkyFlow

BigCommerce connection for LinkyFlow

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

Resources

27

Read requests

26

Write actions

32

Documented fields

372

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.

Catalog

Brands

The brands of your catalogue.

Used as filter by

Read

Brands

The brands of your catalogue.

Route: GET /brands

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or none when the id is unknown.
id_instringNoOnly these record IDs, comma-separated.
namestringNoExactly this name.
name_likestringNo-
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

page_title
default

string

—

-

meta_description

string

—

-

search_keywords

string

—

-

image_url

string

—

-

custom_url

string

—

-

url
default

string

—

-

Create

Create Brand

Create Brand

Route: POST /mutation/brands

Inputs you can set
NameTypeRequiredDescription
image_urlstringNo-
meta_descriptionstringNo-
namestringYes-
page_titlestringNo-
search_keywordsstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Brand

Update Brand

Route: PATCH /mutation/brands

Inputs you can set
NameTypeRequiredDescription
image_urlstringNo-
meta_descriptionstringNo-
namestringYes-
page_titlestringNo-
search_keywordsstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Brand

Delete Brand

Route: DELETE /mutation/brands

Inputs you can set
NameTypeRequiredDescription
image_urlstringNo-
meta_descriptionstringNo-
namestringYes-
page_titlestringNo-
search_keywordsstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Categories

The categories of your catalogue, in every category tree.

Used as filter by

Read

Categories

The categories of your catalogue, in every category tree.

Route: GET /categories

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
category_id_instringNoOnly these category IDs, comma-separated.
parent_id_instringNoOnly the children of these categories, comma-separated; 0 for the top level.
tree_id_instringNoOnly the categories of these trees, comma-separated.
namestringNoExactly this name.
name_likestringNo-
keywordstringNoSearch the name and the description.
is_visiblebooleanNo-
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
category_id
default

id

—

-

name
default

string

—

-

parent_id
default

id

→ categories

-

tree_id

id

—

-

is_visible
default

boolean

—

-

sort_order

number

—

-

page_title

string

—

-

url

string

—

-

path

string

—

-

description

string

—

-

views

number

—

-

Product Custom Fields

The name and value pairs a product shows on its page.

Read

Product Custom Fields

The name and value pairs a product shows on its page.

Route: GET /productCustomFields

Excel formula: =LF.bigcommerce.productCustomFields("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
product_ididYesParent product
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

name
default

string

—

-

value
default

string

—

-

Create

Add Custom Field

Add Custom Field

Route: POST /mutation/productCustomFields

Inputs you can set
NameTypeRequiredDescription
namestringYes-
product_ididYes-
valuestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Custom Field

Update Custom Field

Route: PATCH /mutation/productCustomFields

Inputs you can set
NameTypeRequiredDescription
namestringYes-
product_ididYes-
valuestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Custom Field

Delete Custom Field

Route: DELETE /mutation/productCustomFields

Inputs you can set
NameTypeRequiredDescription
namestringYes-
product_ididYes-
valuestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Images

The images of a product, its thumbnail among them.

Read

Product Images

The images of a product, its thumbnail among them.

Route: GET /productImages

Excel formula: =LF.bigcommerce.productImages("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
product_ididYesParent product
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

is_thumbnail
default

boolean

—

-

sort_order
default

number

—

-

description
default

string

—

-

url_standard
default

string

—

-

date_modified
default

date

—

-

Create

Add Product Image

Add Product Image

Route: POST /mutation/productImages

Inputs you can set
NameTypeRequiredDescription
descriptionstringNo-
image_urlstringYes-
is_thumbnailbooleanNo-
product_ididYes-
sort_ordernumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product Image

Update Product Image

Route: PATCH /mutation/productImages

Inputs you can set
NameTypeRequiredDescription
descriptionstringNo-
image_urlstringYes-
is_thumbnailbooleanNo-
product_ididYes-
sort_ordernumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Product Image

Delete Product Image

Route: DELETE /mutation/productImages

Inputs you can set
NameTypeRequiredDescription
descriptionstringNo-
image_urlstringYes-
is_thumbnailbooleanNo-
product_ididYes-
sort_ordernumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Product Modifiers

The choices a shopper adds to a product that make no variant (a gift note, an engraving), with their price adjustments.

Read

Product Modifiers

The choices a shopper adds to a product that make no variant (a gift note, an engraving), with their price adjustments.

Route: GET /productModifiers

Excel formula: =LF.bigcommerce.productModifiers("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
product_ididYesParent product
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

display_name
default

string

—

-

name

string

—

-

type
default

string

—

-

required
default

boolean

—

-

sort_order

number

—

-

option_values

string

—

-

Product Options

The options a shopper picks to choose a variant (size, colour), with their values.

Read

Product Options

The options a shopper picks to choose a variant (size, colour), with their values.

Route: GET /productOptions

Excel formula: =LF.bigcommerce.productOptions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
product_ididYesParent product
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

display_name
default

string

—

-

name

string

—

-

type
default

string

—

-

sort_order

number

—

-

option_values
default

string

—

-

Product Reviews

What shoppers wrote about a product, and whether it is shown.

Read

Product Reviews

What shoppers wrote about a product, and whether it is shown.

Route: GET /productReviews

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
product_ididYesParent product
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

title
default

string

—

-

rating
default

number

—

-

status
default

enum

—

-

name
default

string

—

-

date_modified
default

date

—

-

Product Variants

The variants of a product: each SKU, its prices and its stock.

Read

Product Variants

The variants of a product: each SKU, its prices and its stock.

Route: GET /productVariants

Excel formula: =LF.bigcommerce.productVariants("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
product_ididYesParent product
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

sku
default

string

—

-

price
default

number

—

-

calculated_price
default

number

—

-

inventory_level
default

number

—

-

Create

Create Variant

Create Variant

Route: POST /mutation/productVariants

Inputs you can set
NameTypeRequiredDescription
cost_pricenumberNo-
gtinstringNo-
image_urlstringNo-
inventory_levelnumberNo-
inventory_warning_levelnumberNo-
map_pricenumberNo-
mpnstringNo-
option_valuesstringYes-
pricenumberNo-
product_ididYes-
purchasing_disabledbooleanNo-
retail_pricenumberNo-
sale_pricenumberNo-
skustringYes-
upcstringNo-
weightnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Variant

Update Variant

Route: PATCH /mutation/productVariants

Inputs you can set
NameTypeRequiredDescription
cost_pricenumberNo-
gtinstringNo-
image_urlstringNo-
inventory_levelnumberNo-
inventory_warning_levelnumberNo-
map_pricenumberNo-
mpnstringNo-
option_valuesstringYes-
pricenumberNo-
product_ididYes-
purchasing_disabledbooleanNo-
retail_pricenumberNo-
sale_pricenumberNo-
skustringYes-
upcstringNo-
weightnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Variant

Delete Variant

Route: DELETE /mutation/productVariants

Inputs you can set
NameTypeRequiredDescription
cost_pricenumberNo-
gtinstringNo-
image_urlstringNo-
inventory_levelnumberNo-
inventory_warning_levelnumberNo-
map_pricenumberNo-
mpnstringNo-
option_valuesstringYes-
pricenumberNo-
product_ididYes-
purchasing_disabledbooleanNo-
retail_pricenumberNo-
sale_pricenumberNo-
skustringYes-
upcstringNo-
weightnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Products

Products in your BigCommerce catalogue.

Read

Products

Products in your BigCommerce catalogue.

Route: GET /products

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or none when the id is unknown.
id_instringNoOnly these record IDs, comma-separated.
namestringNoExactly this name.
skustringNoExactly this SKU.
sku_instringNoOnly these SKUs, comma-separated.
keywordstringNoSearch the name, the SKU and the description.
typeenumNoValues: physical, digital
availabilityenumNoValues: available, disabled, preorder
is_visiblebooleanNoOnly the products shown, or hidden, on the storefront.
is_featuredbooleanNo-
categoriesidNoOnly the products listed in this category.
brand_ididNo-
inventory_level_maxnumberNoOnly the products with this much stock or less.
date_modified_minstringNoOn or after this date (ISO 8601, 2026-01-31 or a date-time).
date_modified_maxstringNoOn or before this date (ISO 8601, 2026-01-31 or a date-time).
sortenumNoField BigCommerce orders by Values: id, name, sku, price, date_modified
directionenumNoValues: asc, desc
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

sku
default

string

—

-

price
default

number

—

-

calculated_price
default

number

—

-

inventory_level
default

number

—

-

availability
default

enum

—

-

is_visible
default

boolean

—

-

date_modified
default

date

—

-

Create

Create Product

Create Product

Route: POST /mutation/products

Inputs you can set
NameTypeRequiredDescription
availabilityenumNoValues: available, disabled, preorder
brand_ididNo-
categoriesstring[]No-
conditionenumNoValues: New, Used, Refurbished
cost_pricenumberNo-
depthnumberNo-
descriptionstringNo-
gtinstringNo-
heightnumberNo-
inventory_levelnumberNo-
inventory_trackingenumNoValues: none, product, variant
inventory_warning_levelnumberNo-
is_featuredbooleanNo-
is_free_shippingbooleanNo-
is_visiblebooleanNo-
map_pricenumberNo-
mpnstringNo-
namestringYes-
page_titlestringNo-
pricenumberYes-
retail_pricenumberNo-
sale_pricenumberNo-
search_keywordsstringNo-
skustringNo-
typeenumYesValues: physical, digital
upcstringNo-
weightnumberYes-
widthnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Update Product

Route: PATCH /mutation/products

Inputs you can set
NameTypeRequiredDescription
availabilityenumNoValues: available, disabled, preorder
brand_ididNo-
categoriesstring[]No-
conditionenumNoValues: New, Used, Refurbished
cost_pricenumberNo-
depthnumberNo-
descriptionstringNo-
gtinstringNo-
heightnumberNo-
inventory_levelnumberNo-
inventory_trackingenumNoValues: none, product, variant
inventory_warning_levelnumberNo-
is_featuredbooleanNo-
is_free_shippingbooleanNo-
is_visiblebooleanNo-
map_pricenumberNo-
mpnstringNo-
namestringYes-
page_titlestringNo-
pricenumberYes-
retail_pricenumberNo-
sale_pricenumberNo-
search_keywordsstringNo-
skustringNo-
typeenumYesValues: physical, digital
upcstringNo-
weightnumberYes-
widthnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Product

Delete Product

Route: DELETE /mutation/products

Inputs you can set
NameTypeRequiredDescription
availabilityenumNoValues: available, disabled, preorder
brand_ididNo-
categoriesstring[]No-
conditionenumNoValues: New, Used, Refurbished
cost_pricenumberNo-
depthnumberNo-
descriptionstringNo-
gtinstringNo-
heightnumberNo-
inventory_levelnumberNo-
inventory_trackingenumNoValues: none, product, variant
inventory_warning_levelnumberNo-
is_featuredbooleanNo-
is_free_shippingbooleanNo-
is_visiblebooleanNo-
map_pricenumberNo-
mpnstringNo-
namestringYes-
page_titlestringNo-
pricenumberYes-
retail_pricenumberNo-
sale_pricenumberNo-
search_keywordsstringNo-
skustringNo-
typeenumYesValues: physical, digital
upcstringNo-
weightnumberYes-
widthnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Variants

Every variant of the store — each SKU, its prices and its stock — across all products.

Read

Variants

Every variant of the store — each SKU, its prices and its stock — across all products.

Route: GET /variants

Excel formula: =LF.bigcommerce.variants("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or none when the id is unknown.
id_instringNoOnly these record IDs, comma-separated.
skustringNoExactly this SKU.
sku_instringNoOnly these SKUs, comma-separated.
product_ididNoOnly the variants of this product.
product_id_instringNoOnly the variants of these product IDs, comma-separated.
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

product_id
default

id

→ products

-

sku
default

string

—

-

price
default

number

—

-

calculated_price
default

number

—

-

inventory_level
default

number

—

-

Customers

Customer Addresses

The addresses your customers ship and bill to.

Read

Customer Addresses

The addresses your customers ship and bill to.

Route: GET /customerAddresses

Excel formula: =LF.bigcommerce.customerAddresses("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
id_instringNoOnly these record IDs, comma-separated.
customer_id_instringNoOnly the addresses of these customer IDs, comma-separated.
company_instringNoOnly these companies, comma-separated.
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

customer_id
default

id

→ customers

-

first_name
default

string

—

-

last_name
default

string

—

-

address1
default

string

—

-

city
default

string

—

-

postal_code
default

string

—

-

country_code
default

string

—

-

Create

Add Customer Address

Add Customer Address

Route: POST /mutation/customerAddresses

Inputs you can set
NameTypeRequiredDescription
address_typeenumNoValues: residential, commercial
address1stringYes-
address2stringNo-
citystringYes-
companystringNo-
country_codestringYes-
customer_ididYes-
first_namestringYes-
last_namestringYes-
phonestringNo-
postal_codestringYes-
state_or_provincestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer Address

Update Customer Address

Route: PATCH /mutation/customerAddresses

Inputs you can set
NameTypeRequiredDescription
address_typeenumNoValues: residential, commercial
address1stringYes-
address2stringNo-
citystringYes-
companystringNo-
country_codestringYes-
customer_ididYes-
first_namestringYes-
last_namestringYes-
phonestringNo-
postal_codestringYes-
state_or_provincestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Customer Address

Delete Customer Address

Route: DELETE /mutation/customerAddresses

Inputs you can set
NameTypeRequiredDescription
address_typeenumNoValues: residential, commercial
address1stringYes-
address2stringNo-
citystringYes-
companystringNo-
country_codestringYes-
customer_ididYes-
first_namestringYes-
last_namestringYes-
phonestringNo-
postal_codestringYes-
state_or_provincestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customer Groups

The groups customers belong to, with the catalogue each may see and the discounts it gets.

Read

Customer Groups

The groups customers belong to, with the catalogue each may see and the discounts it gets.

Route: GET /customerGroups

Excel formula: =LF.bigcommerce.customerGroups("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
namestringNoExactly this name.
is_defaultbooleanNo-
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

is_default
default

boolean

—

-

is_group_for_guests

boolean

—

-

category_access

string

—

-

type
default

enum

—

-

categories

string[]

—

-

discount_rules

string

—

-

date_created

string

—

-

date_modified

string

—

-

Create

Create Customer Group

Create Customer Group

Route: POST /mutation/customerGroups

Inputs you can set
NameTypeRequiredDescription
category_access.categoriesstring[]No-
category_access.typeenumNoValues: all, specific, none
discount_rulesstringNo-
is_defaultbooleanNo-
namestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer Group

Update Customer Group

Route: PATCH /mutation/customerGroups

Inputs you can set
NameTypeRequiredDescription
category_access.categoriesstring[]No-
category_access.typeenumNoValues: all, specific, none
discount_rulesstringNo-
is_defaultbooleanNo-
namestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Customer Group

Delete Customer Group

Route: DELETE /mutation/customerGroups

Inputs you can set
NameTypeRequiredDescription
category_access.categoriesstring[]No-
category_access.typeenumNoValues: all, specific, none
discount_rulesstringNo-
is_defaultbooleanNo-
namestringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customers

The customers of your BigCommerce store.

Used as filter by

Read

Customers

The customers of your BigCommerce store.

Route: GET /customers

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
id_instringNoOnly these record IDs, comma-separated.
email_instringNoOnly these emails, comma-separated.
name_likestringNoSearch the first and last names.
company_instringNoOnly these companies, comma-separated.
customer_group_id_instringNoOnly the customers of these group IDs, comma-separated.
date_created_minstringNoAn ISO 8601 date or date-time.
date_created_maxstringNoAn ISO 8601 date or date-time.
date_modified_minstringNoAn ISO 8601 date or date-time.
date_modified_maxstringNoAn ISO 8601 date or date-time.
sortenumNoField and direction BigCommerce orders by Values: date_created:asc, date_created:desc, last_name:asc, last_name:desc, date_modified:asc
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

email
default

string

—

-

first_name
default

string

—

-

last_name
default

string

—

-

company
default

string

—

-

customer_group_id
default

id

→ customerGroups

-

date_modified
default

date

—

-

Create

Create Customer

Create Customer

Route: POST /mutation/customers

Inputs you can set
NameTypeRequiredDescription
accepts_product_review_abandoned_cart_emailsbooleanNo-
companystringNo-
customer_group_ididNo-
emailstringYes-
first_namestringYes-
last_namestringYes-
notesstringNo-
phonestringNo-
tax_exempt_categorystringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer

Update Customer

Route: PATCH /mutation/customers

Inputs you can set
NameTypeRequiredDescription
accepts_product_review_abandoned_cart_emailsbooleanNo-
companystringNo-
customer_group_ididNo-
emailstringYes-
first_namestringYes-
last_namestringYes-
notesstringNo-
phonestringNo-
tax_exempt_categorystringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Customer

Delete Customer

Route: DELETE /mutation/customers

Inputs you can set
NameTypeRequiredDescription
accepts_product_review_abandoned_cart_emailsbooleanNo-
companystringNo-
customer_group_ididNo-
emailstringYes-
first_namestringYes-
last_namestringYes-
notesstringNo-
phonestringNo-
tax_exempt_categorystringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Inventory

Inventory Levels

The stock of every SKU at a location: on hand, available to sell, and its safety stock.

Read

Inventory Levels

The stock of every SKU at a location: on hand, available to sell, and its safety stock.

Route: GET /inventoryItems

Excel formula: =LF.bigcommerce.inventoryItems("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
location_ididYesThe location the levels are read at
sku_instringNoOnly these SKUs, comma-separated.
product_id_instringNoOnly the SKUs of these product IDs, comma-separated.
variant_id_instringNoOnly these variant IDs, comma-separated.
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
location_id
default

id

→ inventoryLocations

-

identity

string

—

-

sku
default

string

—

-

product_id

id

→ products

-

variant_id
default

id

—

-

total_inventory_onhand
default

number

—

-

available_to_sell
default

number

—

-

qty_backordered

number

—

-

settings

string

—

-

safety_stock

number

—

-

warning_level

number

—

-

is_in_stock

boolean

—

-

bin_picking_number

string

—

-

backorder_limit

number

—

-

Inventory Locations

The places your store keeps stock: warehouses, shops, pickup points.

Read

Inventory Locations

The places your store keeps stock: warehouses, shops, pickup points.

Route: GET /inventoryLocations

Excel formula: =LF.bigcommerce.inventoryLocations("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
location_id_instringNoOnly these location IDs, comma-separated.
location_code_instringNoOnly these codes, comma-separated.
is_activebooleanNo-
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

code
default

string

—

-

label
default

string

—

-

type_id
default

string

—

-

enabled
default

boolean

—

-

storefront_visibility

boolean

—

-

managed_by_external_source

boolean

—

-

description

string

—

-

address

string

—

-

city

string

—

-

country_code

string

—

-

created_at

date

—

-

updated_at

date

—

-

Stock Level

Set the stock a location holds of one SKU, variant or product, to an absolute quantity.

Create

Set Stock Level

Set Stock Level

Route: POST /mutation/inventoryAdjustments

Inputs you can set
NameTypeRequiredDescription
location_ididYes-
product_ididNo-
quantitynumberYes-
reasonstringNo-
skustringNo-
variant_ididNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Marketing

Coupons

The coupon codes your customers enter at checkout.

Read

Coupons

The coupon codes your customers enter at checkout.

Route: GET /coupons

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this coupon. Answers one row, or none when the id is unknown.
codestringNoExactly this code.
namestringNoExactly this name.
typeenumNoValues: per_item_discount, per_total_discount, shipping_discount, free_shipping, percentage_discount
min_idnumberNo-
max_idnumberNo-
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

code
default

string

—

-

type
default

enum

—

-

amount
default

number

—

-

enabled
default

boolean

—

-

expires
default

string

—

-

num_uses
default

number

—

-

Create

Create Coupon

Create Coupon

Route: POST /mutation/coupons

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
applies_to.entityenumNoValues: products, categories
applies_to.idsstring[]No-
codestringYes-
enabledbooleanNo-
expiresstringNo-
max_usesnumberNo-
max_uses_per_customernumberNo-
min_purchasenumberNo-
namestringYes-
typeenumYesValues: per_item_discount, per_total_discount, shipping_discount, free_shipping, percentage_discount
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Coupon

Update Coupon

Route: PATCH /mutation/coupons

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
applies_to.entityenumNoValues: products, categories
applies_to.idsstring[]No-
codestringYes-
enabledbooleanNo-
expiresstringNo-
max_usesnumberNo-
max_uses_per_customernumberNo-
min_purchasenumberNo-
namestringYes-
typeenumYesValues: per_item_discount, per_total_discount, shipping_discount, free_shipping, percentage_discount
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Coupon

Delete Coupon

Route: DELETE /mutation/coupons

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
applies_to.entityenumNoValues: products, categories
applies_to.idsstring[]No-
codestringYes-
enabledbooleanNo-
expiresstringNo-
max_usesnumberNo-
max_uses_per_customernumberNo-
min_purchasenumberNo-
namestringYes-
typeenumYesValues: per_item_discount, per_total_discount, shipping_discount, free_shipping, percentage_discount
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Promotions

The store’s promotions: automatic discounts and those its coupon codes unlock.

Read

Promotions

The store’s promotions: automatic discounts and those its coupon codes unlock.

Route: GET /promotions

Excel formula: =LF.bigcommerce.promotions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this promotion. Answers one row, or none when the id is unknown.
namestringNo-
codestringNoOnly the promotion this code unlocks.
statusenumNoValues: ENABLED, DISABLED, INVALID
redemption_typeenumNoValues: AUTOMATIC, COUPON
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

redemption_type
default

string

—

-

status
default

string

—

-

current_uses
default

number

—

-

max_uses

number

—

-

start_date

date

—

-

end_date

date

—

-

stop

boolean

—

-

can_be_used_with_other_promotions

boolean

—

-

currency_code

string

—

-

rules

string

—

-

Sales

Order Coupons

The coupons applied to an order, and what each took off.

Read

Order Coupons

The coupons applied to an order, and what each took off.

Route: GET /orderCoupons

Excel formula: =LF.bigcommerce.orderCoupons("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
order_ididYesParent order
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

order_id
default

id

→ orders

-

coupon_id

id

→ coupons

-

code
default

string

—

-

amount

number

—

-

type

number

—

-

discount
default

number

—

-

Order Products

The line items of an order: each product sold, its quantity and its price.

Read

Order Products

The line items of an order: each product sold, its quantity and its price.

Route: GET /orderProducts

Excel formula: =LF.bigcommerce.orderProducts("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
order_ididYesParent order
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

order_id
default

id

→ orders

-

name
default

string

—

-

sku
default

string

—

-

quantity
default

number

—

-

price_inc_tax
default

number

—

-

total_inc_tax
default

number

—

-

Order Shipments

The shipments of an order: what left, to which address, with which tracking number.

Read

Order Shipments

The shipments of an order: what left, to which address, with which tracking number.

Route: GET /orderShipments

Excel formula: =LF.bigcommerce.orderShipments("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
order_ididYesParent order
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

order_id
default

id

→ orders

-

date_created
default

string

—

-

tracking_number
default

string

—

-

shipping_provider
default

string

—

-

tracking_carrier

string

—

-

tracking_link

string

—

-

shipping_method

string

—

-

order_address_id

id

—

-

comments

string

—

-

items

string

—

-

Create

Create Shipment

Create Shipment

Route: POST /mutation/orderShipments

Inputs you can set
NameTypeRequiredDescription
commentsstringNo-
itemsstringYes-
order_address_ididYes-
order_ididYes-
shipping_providerstringNo-
tracking_carrierstringNo-
tracking_numberstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Order Shipping Addresses

Where each part of an order ships, and how.

Read

Order Shipping Addresses

Where each part of an order ships, and how.

Route: GET /orderShippingAddresses

Excel formula: =LF.bigcommerce.orderShippingAddresses("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
order_ididYesParent order
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

order_id
default

id

→ orders

-

first_name
default

string

—

-

last_name
default

string

—

-

street_1
default

string

—

-

city
default

string

—

-

country
default

string

—

-

shipping_method
default

string

—

-

Order Statuses

The statuses an order can be in, with the labels the store gives them.

Used as filter by

Read

Order Statuses

The statuses an order can be in, with the labels the store gives them.

Route: GET /orderStatuses

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

custom_label
default

string

—

-

system_label

string

—

-

system_description

string

—

-

order

number

—

-

Order Transactions

The payment transactions recorded on an order: each charge, capture, refund or void, with its gateway.

Read

Order Transactions

The payment transactions recorded on an order: each charge, capture, refund or void, with its gateway.

Route: GET /orderTransactions

Excel formula: =LF.bigcommerce.orderTransactions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
order_ididYesParent order
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

order_id
default

id

→ orders

-

event
default

string

—

-

method
default

string

—

-

amount
default

number

—

-

currency
default

string

—

-

gateway
default

string

—

-

status
default

string

—

-

Orders

Customer orders in your BigCommerce store.

Read

Orders

Customer orders in your BigCommerce store.

Route: GET /orders

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

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
min_idnumberNoOnly orders with this ID or a higher one; equal to To ID for exactly one order.
max_idnumberNo-
status_ididNoOnly the orders in this status.
customer_ididNo-
emailstringNoOnly the orders billed to this email.
min_date_createdstringNoA date, ISO 8601 (2026-01-31) or RFC 2822.
max_date_createdstringNoA date, ISO 8601 (2026-01-31) or RFC 2822.
min_date_modifiedstringNoA date, ISO 8601 (2026-01-31) or RFC 2822.
max_date_modifiedstringNoA date, ISO 8601 (2026-01-31) or RFC 2822.
min_totalnumberNo-
max_totalnumberNo-
payment_methodstringNo-
channel_ididNo-
is_deletedbooleanNoThe archived orders instead of the others.
sortenumNoField and direction BigCommerce orders by Values: id:asc, id:desc, date_created:asc, date_created:desc, date_modified:asc
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

status
default

string

—

-

date_created
default

string

—

-

last_name
default

string

—

-

email
default

string

—

-

total_inc_tax
default

number

—

-

currency_code
default

string

—

-

payment_status
default

string

—

-

Create

Create Order

Create Order

Route: POST /mutation/orders

Inputs you can set
NameTypeRequiredDescription
billing_address.citystringYes-
billing_address.companystringNo-
billing_address.countrystringYes-
billing_address.country_iso2stringYes-
billing_address.emailstringYes-
billing_address.first_namestringYes-
billing_address.last_namestringYes-
billing_address.phonestringNo-
billing_address.statestringNo-
billing_address.street_1stringYes-
billing_address.street_2stringNo-
billing_address.zipstringYes-
customer_ididNo-
customer_messagestringNo-
external_idstringNo-
payment_methodstringNo-
productsstringYes-
staff_notesstringNo-
status_ididNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Order

Update Order

Route: PATCH /mutation/orders

Inputs you can set
NameTypeRequiredDescription
billing_address.citystringYes-
billing_address.companystringNo-
billing_address.countrystringYes-
billing_address.country_iso2stringYes-
billing_address.emailstringYes-
billing_address.first_namestringYes-
billing_address.last_namestringYes-
billing_address.phonestringNo-
billing_address.statestringNo-
billing_address.street_1stringYes-
billing_address.street_2stringNo-
billing_address.zipstringYes-
customer_ididNo-
customer_messagestringNo-
external_idstringNo-
payment_methodstringNo-
productsstringYes-
staff_notesstringNo-
status_ididNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Archive Order

Archive Order

Route: DELETE /mutation/orders

Inputs you can set
NameTypeRequiredDescription
billing_address.citystringYes-
billing_address.companystringNo-
billing_address.countrystringYes-
billing_address.country_iso2stringYes-
billing_address.emailstringYes-
billing_address.first_namestringYes-
billing_address.last_namestringYes-
billing_address.phonestringNo-
billing_address.statestringNo-
billing_address.street_1stringYes-
billing_address.street_2stringNo-
billing_address.zipstringYes-
customer_ididNo-
customer_messagestringNo-
external_idstringNo-
payment_methodstringNo-
productsstringYes-
staff_notesstringNo-
status_ididNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Refunds

The refunds of the store’s orders: what was refunded, when, and why.

Read

Refunds

The refunds of the store’s orders: what was refunded, when, and why.

Route: GET /orderRefunds

Excel formula: =LF.bigcommerce.orderRefunds("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
order_id_instringNoOnly the refunds of these order IDs, comma-separated.
created_minstringNoAn ISO 8601 date or date-time.
created_maxstringNoAn ISO 8601 date or date-time.
per_pagenumberNoRows per page (max 250) Default: 100
pagenumberNoPage number, starting at 1
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

order_id
default

id

→ orders

-

user_id

id

—

-

created
default

date

—

-

reason
default

string

—

-

total_amount
default

number

—

-

total_tax

number

—

-

uses_merchant_override_values

boolean

—

-

items

string

—

-

payments

string

—

-

Store

Store

Your BigCommerce store: its name, its domain, its currency, its units and its plan.

Read

Store

Your BigCommerce store: its name, its domain, its currency, its units and its plan.

Route: GET /store

Excel formula: =LF.bigcommerce.store("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
Data returned in Excel
Field
Type
Relations
Description
id
default

id

—

-

name
default

string

—

-

domain
default

string

—

-

status
default

string

—

-

currency
default

string

—

-

is_price_entered_with_tax
default

boolean

—

-

plan_name
default

string

—

-