How to connect BigCommerce + QuickBooks Online + Square
Zapier lets you send info between BigCommerce, QuickBooks Online, and Square automatically—no code required.
Do even more with BigCommerce + QuickBooks Online + Square
With Zapier, you can do more than just connect your apps - you can automate entire processes from beginning to end! Check out the following list of triggers and actions you can use with BigCommerce, QuickBooks Online, and Square. And don’t forget that you can add more apps and actions to create complex workflows.
Filter by Channel ID
Select the channel
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Customer Created
Triggers when an new customer is created.
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Filter by Channel ID
Select the channel
Filter by Status ID
Select the status
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Shipment Created
Triggers when a new shipment is created.
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Customer Address Updated
Triggers when a customer address is updated.
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Order Status Updated
Triggers when an order status have changed.
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.EmailRequired
The email of the customer. Must be unique.
First NameRequired
The first name of the customer.
Last NameRequired
The last name of the customer.
Company
The company of the customer.
Phone
The phone number of the customer.
Registration IP Address
The IP address from which this customer was registered.
Notes
The customer notes.
Tax Exempt Category
The tax exempt category code for the customer.
Customer Group ID
ID of the group which this customer belongs to.
ID
The unique numeric ID of the customer.
Force Password Reset
If true, this customer will be forced to change password on next login.
New Password
New password for customer.
Accepts Product Review Abandoned Cart Emails
It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails.
Store Credit Amounts
Values must be separated by a comma.
Origin Channel ID
Channel ID of the customer that has created the form.
Channel IDs
Arrays of channels the customer can access. Values must be separated by a comma.
Name
The form field name. Values must be separated by a comma.
Value
Values must be separated by a comma.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.NameRequired
The product name.
TypeRequired
The product type. One of: physical - a physical stock unit, digital - a digital download.
Sku
User defined product code/stock keeping unit (SKU).
Description
The product description, which can include HTML formatting.
WeightRequired
Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store.
Width
Width of the product, which can be used when calculating shipping costs.
Depth
Depth of the product, which can be used when calculating shipping costs.
Height
Height of the product, which can be used when calculating shipping costs.
PriceRequired
The price of the product. The price should include or exclude tax, based on the store settings.
Cost Price
The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
Retail Price
The retail cost of the product. If entered, the retail cost price will be shown on the product page.
Sale Price
If entered, the sale price will be used instead of value in the price field when calculating the product’s cost.
Map Price
Minimum Advertised Price
Tax Class Id
The ID of the tax class applied to the product.
Product Tax Code
Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax.
Categories
An array of IDs for the categories to which this product belongs.
Brand Id
Inventory Level
Current inventory level of the product.
Inventory Warning Level
Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
Inventory Tracking
The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
Fixed Cost Shipping Price
A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
Is Free Shipping
Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero
Is Visible
Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
Is Featured
Flag to determine whether the product should be included in the featured products panel when viewing the store.
Related Products
An array of IDs for the related products.
Warranty
Warranty information displayed on the product page. Can include HTML formatting.
Bin Picking Number
The BIN picking number for the product.
Layout File
The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see Custom Template Associations.
Upc
The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
Search Keywords
A comma-separated list of keywords that can be used to locate the product when searching the store.
Availability Description
Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
Availability
Availability of the product. (Corresponds to the product's Purchasability section in the control panel.) Supported values: available - the product is available for purchase; disabled - the product is listed on the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
Gift Wrapping Options Type
Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
Gift Wrapping Options List
A list of gift-wrapping option IDs.
Sort Order
Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
Condition
The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
Is Condition Shown
Flag used to determine whether the product condition is shown to the customer on the product page.
Order Quantity Minimum
The minimum quantity an order must contain, to be eligible to purchase this product.
Order Quantity Maximum
The maximum quantity an order can contain when purchasing the product.
Page Title
Custom title for the product page. If not defined, the product name will be used as the meta title.
Meta Keywords
Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
Meta Description
Custom meta description for the product page. If not defined, the store's default meta description will be used.
View Count
The number of times the product has been viewed.
Preorder Release Date
Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
Preorder Message
Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
Is Preorder Only
If set to true then on the preorder release date the preorder status will automatically be removed. If set to false, then on the release date the preorder status will not be removed. It will need to be changed manually either in the control panel or using the API. Using the API set availability to available.
Is Price Hidden
False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.).
Price Hidden Label
By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.).
Url
Product URL on the storefront.
Is Customized
Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
Open Graph Type
Type of product, defaults to product.
Open Graph Title
Title of the product, if not specified the product name will be used instead.
Open Graph Description
Description to use for the product, if not specified then the meta_description will be used instead.
Open Graph Use Meta Description
Flag to determine if product description or open graph description is used.
Open Graph Use Product Name
Flag to determine if product name or open graph name is used.
Open Graph Use Image
Flag to determine if product image or open graph image is used.
Gtin
Global Trade Item Number.
Mpn
Manufacturer Part Number.
Reviews Rating Sum
The total (cumulative) rating for the product.
Reviews Count
The number of times the product has been rated.
Total Sold
The total quantity of this product sold.
Custom Fields ID
The unique numeric ID of the custom field. Must be separated by commas
Custom Fields NameRequired
The name of the field, shown on the storefront, orders, etc. Must be separated by commas
Custom Fields ValueRequired
The value of the field, requested on the storefront, orders, etc. Must be separated by commas
Bulk Pricing Rules ID
Unique ID of the Bulk Pricing Rule. Must be separated by commas
Bulk Pricing Rules Quantity Min
The minimum inclusive quantity of a product to satisfy this rule. Must be separated by commas
Bulk Pricing Rules Quantity Max
The maximum inclusive quantity of a product to satisfy this rule. Must be separated by commas
Bulk Pricing Rules Type
The type of adjustment that is made. Must be separated by commas
Bulk Pricing Rules Amount
The discount can be a fixed dollar amount or a percentage. Must be separated by commas
Images Image File
The local path to the original image file uploaded to BigCommerce. Must be separated by commas
Images Is Thumbnail?
Flag for identifying whether the image is used as the product's thumbnail. Must be separated by commas
Images Sort order
The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered. Must be separated by commas
Images Description
The description for the image. Must be separated by commas
Images Image URL
Must be a fully qualified URL path, including protocol. Must be separated by commas
Images ID
The unique numeric ID of the image. Must be separated by commas
Images Product ID
The unique numeric identifier for the product with which the image is associated. Must be separated by commas
Images URL Zoom
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. Must be separated by commas
Images URL Standard
The standard URL for this image. By default, this is used for product-page images. Must be separated by commas
Images URL thumbnail
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. Must be separated by commas
Images URL Tiny
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. Must be separated by commas
Images Date modified
The date on which the product image was modified. Must be separated by commas
Videos Title
The title for the video. If left blank, this will be filled in according to data on a host site. Must be separated by commas
Videos Description
The description for the video. If left blank, this will be filled in according to data on a host site. Must be separated by commas
Videos Sort order
The order in which the video will be displayed on the product page. Must be separated by commas
Videos Type
The video type (a short name of a host site). Must be separated by commas
Videos Video ID
The ID of the video on a host site. Must be separated by commas
Videos ID
The unique numeric ID of the product video; increments sequentially. Must be separated by commas
Videos Product ID
The unique numeric identifier for the product with which the image is associated. Must be separated by commas
Videos Length
Length of the video. This will be filled in according to data on a host site. Must be separated by commas
Variants Cost Price
The cost price of the variant. Not affected by Price List prices. Must be separated by commas
Variants Price
This variant’s base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s default price (set in the Product resource’s price field) will be used as the base price. Must be separated by commas
Variants Sale Price
This variant’s sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s sale price (set in the Product resource’s price field) will be used as the sale price. Must be separated by commas
Variants Retail Price
This variant’s retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s retail price (set in the Product resource’s price field) will be used as the retail price. Must be separated by commas
Variants Weight
This variant’s base weight on the storefront. If this value is null, the product’s default weight (set in the Product resource’s weight field) will be used as the base weight. Must be separated by commas
Variants Width
Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width. Must be separated by commas
Variants Height
Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height. Must be separated by commas
Variants Depth
Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth. Must be separated by commas
Variants Is free shipping?
Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero. Must be separated by commas
Variants Fixed cost shipping price
A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. Must be separated by commas
Variants Purchasing disabled
If true, this variant will not be purchasable on the storefront. Must be separated by commas
Variants Purchasing disabled message
If purchasing_disabled is true, this message should show on the storefront when the variant is selected. Must be separated by commas
Variants UPC
The UPC code used in feeds for shopping comparison sites and external channel integrations. Must be separated by commas
Variants Inventory level
Inventory level for the variant, which is used when the product’s inventory_tracking is set to variant. Must be separated by commas
Variants Inventory warning level
When the variant hits this inventory level, it is considered low stock. Must be separated by commas
Variants BIN Picking number
Identifies where in a warehouse the variant is located. Must be separated by commas
Variants Product ID
Must be separated by commas
Variants SKU
Must be separated by commas
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Email
Filter customers by email.
Company
Filter customers by company.
ID
Filter customers by id.
Customer Group
Filter customers by customer group.
ActionThis is an event a Zap performs.SearchFind existing data in your appName
Filter items by name.
SKU
Filter items by main SKU.
ID
Filter items by ID.
ActionThis is an event a Zap performs.SearchFind existing data in your appName
Company
The company of the customer address
Customer ID
First NameRequired
The first name of the customer address.
Last NameRequired
The last name of the customer address
Address 1Required
The address 1 line
Address 2
The address 2 line
CityRequired
The city of the customer address
State Or ProvinceRequired
The state or province name spelled out in full. It is required for countries that need a state/province to complete an address. State or province codes not accepted.
Postal CodeRequired
The postal code of the customer address. It is required for countries that need postal codes to complete an address.
Country CodeRequired
The country code of the customer address.
Phone
The phone number of the customer address
Address Type
The address type. Residential or Commercial.
Customer IdRequired
The customer ID
Id
The unique numeric ID of the address.
Country
The country name of the customer address
Name
If you have required address form fields they will need to be set as optional before creating an order with the API.
Value
If you have required address form fields they will need to be set as optional before creating an order with the API.
ActionThis is an event a Zap performs.Search or writeFind existing data in your app, or create a new record if no data is foundNew Account
Triggered when you add a new account.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Customer
Triggered when you add a new customer.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Expense
Triggers when a new expense is added.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Invoice
Triggered when you add a new invoice (with line item support).
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Payment
Triggered when a payment is received (with line item support).
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Sales Receipt
Triggered when a new sales receipt is added.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Vendor
Triggered when a new vendor is added.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planVendorRequired
Terms
Transaction Date
Due Date
Bill Number
Department
Currency
Only available if multicurrency is enabled.
Global Tax Calculation
Description
AmountRequired
Billable?
If a line item is billable, please use the Customer field to specify which customer.
Customer
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
AccountRequired
Tax Code
AP Account
Memo
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.CustomerRequired
Email
Send Later?
Billing Address
Credit Memo Date
Defaults to today's date if not specified.
Credit Memo Number
Class
Only available if class tracking is enabled and assigned using the "one to entire transaction" option.
AmountRequired
Service Date
Product/Service
Description
Quantity
Rate
Tax
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Message Displayed On Credit Memo
Memo
Apply Tax After Discount?
US versions of QuickBooks only.
Discount Value
Discount Percent
Sales Tax Rate
Shipping Cost
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.CustomerRequired
Select a specific customer.
Number
Max of 21 characters. If empty, Quickbooks will generate one by incrementing the last number, but only if you have custom transaction numbers disabled. number automatically. Max of 21 characters.
Line AmountRequired
Should not include tax.
Line Description
Line Item/Product
Line Item Quantity
Line Item Tax Code
Line Item Service Date
Format: YYYY-MM-DD
Rate
When using this field, the Rate * Quantity must be equal to the line amount
Expiration Date
Message displayed on estimate
Billing Address
If the customer you enter in the "Customer" field has a default billing address, that address will be used if this field is left blank.
Shipping Address
If the customer you enter in the "Customer" field has a default shipping address, that address will be used if this field is left blank.
Shipping amount
Bill Email
Email address where estimate is sent. Separate emails with commas for multiple addresses
Send later
If set to true, the Bill Email field should also be provided
Discount Value
Discount values must be positive (e.g.
10
for a 10 value discount)Discount Percent
Discount values must be positive (e.g.
10
for a 10% discount)
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.TypeRequired
NameRequired
Description On Sales Forms
Sales Price/Rate
Description On Purchase Forms
Cost
SKU
Category
Is Taxable?
Only applicable to US companies.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.CustomerRequired
Email
If not set, the customer's primary email will be used.
Cc
Bcc
Send Later?
Billing Address
If the customer you enter in the "Customer" field has a default billing address, that address will be used if this field is left blank.
Shipping Address
If the customer you enter in the "Customer" field has a default shipping address, that address will be used if this field is left blank.
Terms
Invoice Date
Defaults to today's date if not specified.
Due Date
Ship Via
Shipping Date
Tracking Number
Invoice Number
If empty, no Invoice number is added. Max of 21 characters or put AUTO_GENERATE to let QuickBooks increment this automatically.
Service Date
Product/Service
Description
Quantity
Rate
Should not include tax.
AmountRequired
Should not include tax.
Tax
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Message Displayed on Invoice
Message Displayed on Statement
Accept Payment Via Bank Transfer
Accept Payment Via Credit Card
Tax Code
Total Tax
Requires choosing a Tax Code above.
Tax Calculation
Method in which tax is applied.
Apply Tax After Discount?
Discount Value
Discount values must be positive (e.g.
.10
for a 10% discount)Discount Percent
Shipping Tax
Shipping
Deposit
Class
Only available if class tracking is enabled and assigned using the "one to entire transaction" option.
Department
Only available if your preferences allow tracking of department.
Location
Only available for France locales.
Currency
Only available if multicurrency is enabled. Defaults to your home currency if left blank.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.CustomerRequired
Total AmountRequired
Unapplied Amount
The amount that has not been applied to pay amounts owed for sales transactions.
Transaction Date
Payment Method
Payment Reference Number
Deposit To Account
A.K.A. Income Account
Line Amount
Should not include tax.
Memo
Line Linked Invoice
Only choose an invoice if this payment is linked to one.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Refund FromRequired
Customer
Email
Billing Address
If the customer you enter in the "Customer" field has a default billing address, that address will be used if this field is left blank.
Refund Receipt Date
Defaults to today's date if not specified.
Refund Receipt Number
Transaction Class
Only available if class tracking is enabled and assigned using the "one to entire transaction" option.
Payment Method
Check Number
Print Later?
Product/ServiceRequired
AmountRequired
Service Date
Description
Quantity
Rate
Tax
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Message Displayed On Refund Receipt
Memo
Apply Tax After Discount?
US versions of QuickBooks only.
Discount Value
Discount Percent
Sales Tax Rate
Shipping
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Sales ReceiptRequired
Email
Send to an explicit email address instead of the receipt billing one, and updates the one on the sales receipt to this.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.CustomerRequired
Company
Email
Title
First name
Middle name
Last name
Suffix
Display name as
Must be unique for every customer.
Phone
Mobile
Fax
Other
Website
Print On Check As
Notes
Billing Address - Street
Billing Address - City/Town
Billing Address - State/Province
Billing Address - ZIP code
Billing Address - Country
Shipping Address - Street
Shipping Address - City/Town
Shipping Address - State/Province
Shipping Address - ZIP code
Shipping Address - Country
Exemption Details
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Full NameRequired
PhoneRequired
Email
Website
Address Line 1
Address Line 2
Address City
Address State Code
Address Zip Code
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Account NameRequired
ActionThis is an event a Zap performs.SearchFind existing data in your appInvoice NumberRequired
ActionThis is an event a Zap performs.SearchFind existing data in your appNameRequired
Enter the vendor's display name exactly as it appears in QuickBooks Online.
ActionThis is an event a Zap performs.SearchFind existing data in your appFull NameRequired
Enter the vendor's display name exactly as it appears in QuickBooks Online.
PhoneRequired
Email
Website
Address Line 1
Address Line 2
Address City
Address State Code
Address Zip Code
ActionThis is an event a Zap performs.Search or writeFind existing data in your app, or create a new record if no data is foundLocationRequired
Only Active locations listed.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planLocation
Only Active locations listed.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planLocationRequired
Only Active locations listed.
Team Member IDRequired
The team member must be bookable for the service that will be part of the new appointment.
Customer IDRequired
The customer to receive the service provided by the assigned or selected team member.
Date and Time of AppointmentRequired
Example: "Next Saturday at noon." The appointment will be booked for the first available time slot within 32 days of this date.
Appointment Service IDRequired
Note
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.First Name
Last Name
Email Address
Phone Number
Country
Street Address
Apt./Suite
City
State
ZIP
Other
Any other info you want to note about this customer.
Company
Nickname
Reference Id
An optional second ID you can set to associate the customer with an entity in another system.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.LocationRequired
Customer ID
Provide either this field or Display Name.
External Identifier
Reference to associate an entity in another system with this order.
Buyer Email Address
Used to notify the buyer of payment.
Payment TypeRequired
The type of external payment received. Currently only external payments are supported.
Payment Note
An optional note to be included with the payment of the order.
QuantityRequired
AmountRequired
Amount in the lowest monetary value (in the US, this is cents).
CurrencyRequired
Line Item Name
Either Line Item Name or Catalog Item Variation ID is required.
Catalog Item Variation ID
Either Line Item Name or Catalog Item Variation ID is required.
Pickup
Only Shipment orders are supported at this time.
Display Name
Provide either this field or Customer ID.
Carrier
Expected Ship Date/Time
Shipping Note
Fulfillment Email Address
Phone number of the fulfillment recipient
Address Line 1
Address Line 2
State
County
Country
City
Postal Code
Discount Type
Choose a discount type to enter discount details.
Name
Required if including discounts
Percentage
Required if Fixed Percentage was selected above.
Amount Discounted
Required if Fixed Amount was selected above. Amount in the lowest monetary value (in the US, this is cents).
Discount Currency
Required if Fixed Amount was selected above.
Name
Required if a tax is included
Percentage
Required if a tax is included
Type
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Customer IDRequired
GroupRequired
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Customer IDRequired
First Name
Last Name
Email Address
Phone Number
Country
Street Address
Apt./Suite
City
State
ZIP
Other
Any other info you want to note about this customer.
Company
Nickname
Reference ID
An optional second ID you can set to associate the customer with an entity in another system.
Birthday
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Field Help
If all the below fields are empty, the most recently created customer will be returned. If more than one customer is found, the most recently created customer will be returned. If more than one field is used, a customer must match all fields.
Email Address
Phone Number
Phone number must be in E164 format with a leading + sign and country code. For example, +12061112222 or +0012061112222.
Reference ID
ActionThis is an event a Zap performs.SearchFind existing data in your appLocationRequired
Only Active locations listed.
Field Help
If all the below fields are empty, the most recently created order will be returned.
Customer
Fulfillment State
Status
ActionThis is an event a Zap performs.SearchFind existing data in your appLocationRequired
Only Active locations listed.
Field Help
If all the below fields are empty, the most recently created order will be returned.
Customer
Fulfillment State
Status
Customer ID
External Identifier
Source
Ticket Name
Must be 30 characters or less
Quantity
Required if line items are added
Amount
Required if line items are added
Currency
Required if line items are added
Catalog Item Variation ID
Note
Unique Identifier
Must contain only alphanumeric characters, dots, underscores, and hyphens.
Amount Discounted
Required if discounts are included unless a percent is specified below
Amount Discounted Currency
Required if an amount is specified above
Name
Required if including discounts
Percentage
Required if discounts are included unless an above amount is specified
Type
Unique Identifier
Must contain only letters, numbers, dots, underscores, and hyphens.
Name
Required if a tax is included
Percentage
Required if a tax is included
Type
Unique Identifier
Must contain only alphanumeric characters, dots, underscores, and hyphens.
ActionThis is an event a Zap performs.Search or writeFind existing data in your app, or create a new record if no data is found
Filter by Channel ID
Select the channel
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Customer Address Created
Triggers when a new customer is created.
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Filter by Category ID
Select the category
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Customer Updated
Triggers when a customer is updated.
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.Filter by Channel ID
Select the channel
Filter by Status ID
Select the status
Try ItTriggerThis is the start of your ZapInstantThis event starts a Zap instantly.TitleRequired
Title of this blog post.
Url
URL for the public blog post.
BodyRequired
Text body of the blog post.
Is Published
Whether the blog post is published.
Meta Description
Description text for this blog post’s
<meta/>
elementMeta Keywords
Keywords for this blog post’s
<meta/>
elementAuthor
Name of the blog post’s author
Thumbnail Path
Local path to a thumbnail uploaded to
/product_images/
via WebDavTags
Tags to characterize the blog post. Must be separated by comma
Published Date
Example:
Wed, 10 Aug 2022 15:39:15 -0500
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.First NameRequired
The first name of the customer address.
Last NameRequired
The last name of the customer address
Company
The company of the customer address
Address 1Required
The address 1 line
Address 2
The address 2 line
CityRequired
The city of the customer address
State Or ProvinceRequired
The state or province name spelled out in full. It is required for countries that need a state/province to complete an address. State or province codes not accepted.
Postal CodeRequired
The postal code of the customer address. It is required for countries that need postal codes to complete an address.
Country CodeRequired
The country code of the customer address.
Phone
The phone number of the customer address
Address Type
The address type. Residential or Commercial.
Customer IdRequired
The customer ID
Id
The unique numeric ID of the address.
Country
The country name of the customer address
Name
If you have required address form fields they will need to be set as optional before creating an order with the API.
Value
If you have required address form fields they will need to be set as optional before creating an order with the API.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Api Docs Info
API docs for BigCommerce are located here https://developer.bigcommerce.com/api/
HTTP MethodRequired
URLRequired
Requests can only be made to domains associated by this application.
Query String Parameters
These params will be URL-encoded and appended to the URL when making the request.
Headers
Authentication headers are included automatically
Additional Request Headers
Zapier will apply these optional headers and values to the request in addition to any headers created as part of the authentication mechanism.
Body
Zapier will pass this along raw. If you would like to provide complex JSON, try a "Code by Zapier" step to build the structure and pass it along here. For example,
{"foo": "bar"}
is perfectly valid.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Name
Company
Customer ID
ActionThis is an event a Zap performs.SearchFind existing data in your appEmailRequired
The email of the customer. Must be unique.
Company
The company of the customer.
ID
The unique numeric ID of the customer.
Customer Group
Filter customers by customer group.
First NameRequired
The first name of the customer.
Last NameRequired
The last name of the customer.
Phone
The phone number of the customer.
Registration IP Address
The IP address from which this customer was registered.
Notes
The customer notes.
Tax Exempt Category
The tax exempt category code for the customer.
Customer Group ID
ID of the group which this customer belongs to.
Force Password Reset
If true, this customer will be forced to change password on next login.
New Password
New password for customer.
Accepts Product Review Abandoned Cart Emails
It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails.
Store Credit Amounts
Values must be separated by a comma.
Origin Channel ID
Channel ID of the customer that has created the form.
Channel IDs
Arrays of channels the customer can access. Values must be separated by a comma.
Name
The form field name. Values must be separated by a comma.
Value
Values must be separated by a comma.
ActionThis is an event a Zap performs.Search or writeFind existing data in your app, or create a new record if no data is foundNameRequired
The product name.
SKU
User defined product code/stock keeping unit (SKU).
ID
Filter items by ID.
TypeRequired
The product type. One of: physical - a physical stock unit, digital - a digital download.
Description
The product description, which can include HTML formatting.
WeightRequired
Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store.
Width
Width of the product, which can be used when calculating shipping costs.
Depth
Depth of the product, which can be used when calculating shipping costs.
Height
Height of the product, which can be used when calculating shipping costs.
PriceRequired
The price of the product. The price should include or exclude tax, based on the store settings.
Cost Price
The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.
Retail Price
The retail cost of the product. If entered, the retail cost price will be shown on the product page.
Sale Price
If entered, the sale price will be used instead of value in the price field when calculating the product’s cost.
Map Price
Minimum Advertised Price
Tax Class Id
The ID of the tax class applied to the product.
Product Tax Code
Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax.
Categories
An array of IDs for the categories to which this product belongs.
Brand Id
Inventory Level
Current inventory level of the product.
Inventory Warning Level
Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect.
Inventory Tracking
The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels.
Fixed Cost Shipping Price
A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
Is Free Shipping
Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero
Is Visible
Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
Is Featured
Flag to determine whether the product should be included in the featured products panel when viewing the store.
Related Products
An array of IDs for the related products.
Warranty
Warranty information displayed on the product page. Can include HTML formatting.
Bin Picking Number
The BIN picking number for the product.
Layout File
The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see Custom Template Associations.
Upc
The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.
Search Keywords
A comma-separated list of keywords that can be used to locate the product when searching the store.
Availability Description
Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.'
Availability
Availability of the product. (Corresponds to the product's Purchasability section in the control panel.) Supported values: available - the product is available for purchase; disabled - the product is listed on the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.
Gift Wrapping Options Type
Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field.
Gift Wrapping Options List
A list of gift-wrapping option IDs.
Sort Order
Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
Condition
The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished.
Is Condition Shown
Flag used to determine whether the product condition is shown to the customer on the product page.
Order Quantity Minimum
The minimum quantity an order must contain, to be eligible to purchase this product.
Order Quantity Maximum
The maximum quantity an order can contain when purchasing the product.
Page Title
Custom title for the product page. If not defined, the product name will be used as the meta title.
Meta Keywords
Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
Meta Description
Custom meta description for the product page. If not defined, the store's default meta description will be used.
View Count
The number of times the product has been viewed.
Preorder Release Date
Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
Preorder Message
Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date.
Is Preorder Only
If set to true then on the preorder release date the preorder status will automatically be removed. If set to false, then on the release date the preorder status will not be removed. It will need to be changed manually either in the control panel or using the API. Using the API set availability to available.
Is Price Hidden
False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.).
Price Hidden Label
By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.).
Url
Product URL on the storefront.
Is Customized
Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).
Open Graph Type
Type of product, defaults to product.
Open Graph Title
Title of the product, if not specified the product name will be used instead.
Open Graph Description
Description to use for the product, if not specified then the meta_description will be used instead.
Open Graph Use Meta Description
Flag to determine if product description or open graph description is used.
Open Graph Use Product Name
Flag to determine if product name or open graph name is used.
Open Graph Use Image
Flag to determine if product image or open graph image is used.
Gtin
Global Trade Item Number.
Mpn
Manufacturer Part Number.
Reviews Rating Sum
The total (cumulative) rating for the product.
Reviews Count
The number of times the product has been rated.
Total Sold
The total quantity of this product sold.
Custom Fields ID
The unique numeric ID of the custom field. Must be separated by commas
Custom Fields NameRequired
The name of the field, shown on the storefront, orders, etc. Must be separated by commas
Custom Fields ValueRequired
The value of the field, requested on the storefront, orders, etc. Must be separated by commas
Bulk Pricing Rules ID
Unique ID of the Bulk Pricing Rule. Must be separated by commas
Bulk Pricing Rules Quantity Min
The minimum inclusive quantity of a product to satisfy this rule. Must be separated by commas
Bulk Pricing Rules Quantity Max
The maximum inclusive quantity of a product to satisfy this rule. Must be separated by commas
Bulk Pricing Rules Type
The type of adjustment that is made. Must be separated by commas
Bulk Pricing Rules Amount
The discount can be a fixed dollar amount or a percentage. Must be separated by commas
Images Image File
The local path to the original image file uploaded to BigCommerce. Must be separated by commas
Images Is Thumbnail?
Flag for identifying whether the image is used as the product's thumbnail. Must be separated by commas
Images Sort order
The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered. Must be separated by commas
Images Description
The description for the image. Must be separated by commas
Images Image URL
Must be a fully qualified URL path, including protocol. Must be separated by commas
Images ID
The unique numeric ID of the image. Must be separated by commas
Images Product ID
The unique numeric identifier for the product with which the image is associated. Must be separated by commas
Images URL Zoom
The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. Must be separated by commas
Images URL Standard
The standard URL for this image. By default, this is used for product-page images. Must be separated by commas
Images URL thumbnail
The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. Must be separated by commas
Images URL Tiny
The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. Must be separated by commas
Images Date modified
The date on which the product image was modified. Must be separated by commas
Videos Title
The title for the video. If left blank, this will be filled in according to data on a host site. Must be separated by commas
Videos Description
The description for the video. If left blank, this will be filled in according to data on a host site. Must be separated by commas
Videos Sort order
The order in which the video will be displayed on the product page. Must be separated by commas
Videos Type
The video type (a short name of a host site). Must be separated by commas
Videos Video ID
The ID of the video on a host site. Must be separated by commas
Videos ID
The unique numeric ID of the product video; increments sequentially. Must be separated by commas
Videos Product ID
The unique numeric identifier for the product with which the image is associated. Must be separated by commas
Videos Length
Length of the video. This will be filled in according to data on a host site. Must be separated by commas
Variants Cost Price
The cost price of the variant. Not affected by Price List prices. Must be separated by commas
Variants Price
This variant’s base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s default price (set in the Product resource’s price field) will be used as the base price. Must be separated by commas
Variants Sale Price
This variant’s sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s sale price (set in the Product resource’s price field) will be used as the sale price. Must be separated by commas
Variants Retail Price
This variant’s retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s retail price (set in the Product resource’s price field) will be used as the retail price. Must be separated by commas
Variants Weight
This variant’s base weight on the storefront. If this value is null, the product’s default weight (set in the Product resource’s weight field) will be used as the base weight. Must be separated by commas
Variants Width
Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width. Must be separated by commas
Variants Height
Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height. Must be separated by commas
Variants Depth
Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth. Must be separated by commas
Variants Is free shipping?
Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero. Must be separated by commas
Variants Fixed cost shipping price
A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. Must be separated by commas
Variants Purchasing disabled
If true, this variant will not be purchasable on the storefront. Must be separated by commas
Variants Purchasing disabled message
If purchasing_disabled is true, this message should show on the storefront when the variant is selected. Must be separated by commas
Variants UPC
The UPC code used in feeds for shopping comparison sites and external channel integrations. Must be separated by commas
Variants Inventory level
Inventory level for the variant, which is used when the product’s inventory_tracking is set to variant. Must be separated by commas
Variants Inventory warning level
When the variant hits this inventory level, it is considered low stock. Must be separated by commas
Variants BIN Picking number
Identifies where in a warehouse the variant is located. Must be separated by commas
Variants Product ID
Must be separated by commas
Variants SKU
Must be separated by commas
ActionThis is an event a Zap performs.Search or writeFind existing data in your app, or create a new record if no data is foundNew Bill
Triggers when a new bill is added.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Estimate
Triggered when you add a new estimate.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Invoice
Triggered when you add a new invoice.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Sales Receipt
Triggered when a new sales receipt is added (with line item support).
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Purchase Order
Triggers when a new purchase order is added.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planUpdated Customer
Triggered when an existing customer is updated.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planVendorRequired
Specifies the vendor for this bill.
Bill Number
Line Item
Line Description
AmountRequired
Amount of the line item.
Qty
Quantity of the line item.
Unit Price
Unit Price of the line item.
Line Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
AP Account
Customer
Specifies the customer associated with the bill.
Due Date
Transaction Date
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.VendorRequired
Specifies the vendor for this bill.
Terms
Transaction Date
Due Date
Bill Number
Department
Global Tax Calculation
Product/Service
Description
Qty
Rate
AmountRequired
Billable?
If a line item is billable, please use the Customer field to specify which customer.
Customer
Line Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Tax Code
AP Account
Memo
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Full NameRequired
Display Name
If not set, Full Name will be used here.
Title
First Name
Last Name
Company
Email
Phone
Mobile
Fax
Website
GST Registration Type
GSTIN
Address Line 1
Address Line 2
Address City
Address State Code
Address Zip Code
Address Country
Shipping Address Line 1
Shipping Address Line 2
Shipping Address City
Shipping Address State Code
Shipping Address Zip Code
Shipping Address Country
Notes
Currency
Only available if multicurrency is enabled.
Tax Registration Number
Tax Resale Number
Job/Parent Customer
Choose a Parent Customer if you're creating a Job/sub-customer.
Bill with Parent?
If no, this customer will be billed.
Preferred Payment Method
Preferred Delivery Method
Terms
Customer Type
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Payee TypeRequired
Is the payee a Vendor, Customer, or Employee?
Payment TypeRequired
Bank/Credit AccountRequired
Payment Date
Defaults to today's date if not specified.
Payment Method
Reference Number
Will be used as check number if payment type is check.
Print Later?
Only applicable if payment type is check.
Account
Description
Amount
You must enter an amount here or in the "Amount" field under "Item Details."
Billable Status
Tax Code
Customer
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Product/Service
Description
Quantity
Rate
Amount
You must enter an amount here or in the "Amount" field under "Account Details."
Billable Status
Tax Code
Customer
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Memo
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Journal Date
Defaults to today's date if not specified.
Journal Number
AccountRequired
Debit AmountRequired
Total amount of "Debits" line items must equal the total amount of "Credits" line items.
Description
Customer Name
Vendor Name
Employee Name
Department
Only available if your preferences allow tracking of department.
Class
AccountRequired
Credit AmountRequired
Total amount of "Credits" line items must equal the total amount of "Debits" line items.
Description
Customer Name
Vendor Name
Employee Name
Department
Only available if your preferences allow tracking of department.
Class
Memo
Currency
Only available if multicurrency is enabled. Defaults to your home currency if left blank.
Exchange Rate
Only available if multicurrency is enabled.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Customer
Select a specific customer, or, use the below field to look up a customer on demand.
Find Customer by Name/Email
If you just have access to the customer's name or email, use this.
Email
Send Later?
Note
Message
Line AmountRequired
Should not include tax.
Service Date
Line Description
Product/Service
Line Item Quantity
Line Item Unit Price
Should not include tax.
Line Item Tax Code
Line Item Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Transaction Date
Total Discount
Will be added as a Discount Line item. The company preference Sales Form Entry | Discounts must be enabled.
Payment Method
Payment Reference Number
Deposit To Account
A.K.A. Income Account
Sales Receipt Number
Address Line 1
Address Line 2
Address City
Address State Code
Address Zip Code
Address Country
Shipping Address Line 1
Shipping Address Line 2
Shipping Address City
Shipping Address State Code
Shipping Address Zip Code
Shipping Address Country
Currency
Only available if multicurrency is enabled.
Exchange Rate
The number of home currency units it takes to equal one unit of currency specified above. Only available if multicurrency is enabled.
Class
Only available if class tracking is enabled and assigned using the "one to entire transaction" option.
Tax Code
Total Tax
Requires choosing a Tax Code above.
Tax Calculation
Method in which tax is applied.
Shipping Tax
Shipping Cost
Department
Only available if your preferences allow tracking of department.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.VendorRequired
Purchase Order Status
Mailing Address
Address to which the payment should be sent.
Shipping Address
Address to which the vendor shipped or will ship goods associated with purchase.
Purchase Order Date
Ship Via
Purchase Order Number
Account
Description
Amount
You must enter an amount here or in the "Amount" field under "Item Details."
Customer
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Product/Service
Description
Quantity
Rate
Amount
You must enter an amount here or in the "Amount" field under "Account Details."
Customer
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Your Message to Vendor
Memo
For internal use. Will not appear on purchase order to vendor
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.InvoiceRequired
EmailRequired
Send to an explicit email address instead of the invoice billing one, and updates the one on the invoice to this.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Time Activity TypeRequired
Is this for an Employee or Vendor?
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.InvoiceRequired
Customer
Email
Cc
Bcc
Send Later?
Billing Address
Shipping Address
Terms
Invoice Date
Due Date
Ship Via
Shipping Date
Tracking Number
Invoice Number
Service Date
Product/Service
Description
Quantity
Rate
Should not include tax.
Amount
Should not include tax.
Tax
Class
Only available if class tracking is enabled and assigned using the "one to each row in transaction" option.
Message Displayed on Invoice
Message Displayed on Statement
Accept Payment Via Bank Transfer
Accept Payment Via Credit Card
Tax Code
Total Tax
Requires choosing a Tax Code above.
Tax Calculation
Method in which tax is applied.
Apply Tax After Discount?
Discount Value
Discount values must be positive (e.g.
.10
for a 10% discount)Discount Percent
Shipping Tax
Shipping
Deposit
Class
Only available if class tracking is enabled and assigned using the "one to entire transaction" option.
Department
Only available if your preferences allow tracking of department.
Location
Only available for France locales.
Currency
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Api Docs Info
API docs for Quickbooks are located here https://developer.intuit.com/app/developer/qbo/docs/develop
HTTP MethodRequired
URLRequired
Requests can only be made to domains associated by this application.
Query String Parameters
These params will be URL-encoded and appended to the URL when making the request.
Headers
Authentication headers are included automatically
Additional Request Headers
Zapier will apply these optional headers and values to the request in addition to any headers created as part of the authentication mechanism.
Body
Zapier will pass this along raw. If you would like to provide complex JSON, try a "Code by Zapier" step to build the structure and pass it along here. For example,
{"foo": "bar"}
is perfectly valid.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Search FieldRequired
Search ValueRequired
Depending on which "Search Field" you selected, the search value must exactly match the "Display name as" field or "Email" field in Quickbooks.
ActionThis is an event a Zap performs.SearchFind existing data in your appProduct NameRequired
ActionThis is an event a Zap performs.SearchFind existing data in your appSearch FieldRequired
Search ValueRequired
Depending on which "Search Field" you selected, the search value must exactly match the "Display name as" field or "Email" field in Quickbooks.
Full NameRequired
Display Name
If not set, Full Name will be used here.
Title
First Name
Last Name
Company
Email
Phone
Mobile
Fax
Website
GST Registration Type
GSTIN
Address Line 1
Address Line 2
Address City
Address State Code
Address Zip Code
Address Country
Shipping Address Line 1
Shipping Address Line 2
Shipping Address City
Shipping Address State Code
Shipping Address Zip Code
Shipping Address Country
Notes
Currency
Only available if multicurrency is enabled.
Tax Registration Number
Tax Resale Number
Job/Parent Customer
Choose a Parent Customer if you're creating a Job/sub-customer.
Bill with Parent?
If no, this customer will be billed.
Preferred Payment Method
Preferred Delivery Method
Terms
Customer Type
ActionThis is an event a Zap performs.Search or writeFind existing data in your app, or create a new record if no data is foundNew Appointment
Triggers when a new appointment is created.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planNew Customer
Triggers when a new customer is created.
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planLocationRequired
Only Active locations listed.
Order Status
Try ItTriggerThis is the start of your ZapScheduledZapier checks for new data every 15 min on the Free planCustomer IDRequired
GroupRequired
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.Inventory Change TypeRequired
Use Adjustment for the normal lifecycle of buying/selling goods. Use Physical Count when a manual count reflects a new inventory amount - item(s) must be In Stock to use this type.
LocationRequired
Only Active locations listed.
Catalog ObjectRequired
QuantityRequired
The number of items affected by the adjustment or physical transfer. Can support up to 5 digits after the decimal point.
Ignore unchanged counts
If True, a physical count update will be ignored if it doesn't change the quantity. Defaults to True.
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.LocationRequired
Only Active locations listed.
Order IDRequired
The order must be open to create an invoice (Must select a location first).
Customer IDRequired
The customer who receives the invoice. This customer data is displayed on the invoice and used by Square to deliver the invoice.
Accepted Payment MethodsRequired
Payment due dateRequired
Tipping enabled
Invoice title
Invoice number
A user-friendly invoice number that is displayed on the invoice. The value is unique within a location. If not provided when creating an invoice, Square assigns a value.
Description
Max length: 65536 characters.
Delivery methodRequired
The delivery method used to send the invoice, reminders, and receipts to the customer. For invoices with automatic payments, this field must be set to
Email
.Scheduled at
Date of sale
ActionThis is an event a Zap performs.WriteCreate a new record or update an existing record in your app.PaymentRequired
A completed payment to apply the refund (Your account must have at least one completed payment to set this Action).
Refund amount
Amount in the lowest monetary value (in the US, this is cents). If left blank, the refund will be issued for the original full payment amount.
Reason
A description of the reason for the refund.
Team member
An optional team member to associate with this refund
ActionThis is an event a Zap performs.Write