Share via


BigCommerce (Preview)

BigCommerce is a flexible, open SaaS platform. Connect to BigCommerce to retrieve orders, products, and related information.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft Dynamics
URL https://aka.ms/iomsupport
Email iomdri@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://www.bigcommerce.com/
Privacy policy https://www.bigcommerce.com/privacy/
Categories Productivity

This connector was specifically developed to be used for Dynamics 365 Intelligent Order Management's Big Commerce provider integration.

Prerequisites

A BigCommerce developer account and test store is required. If you don't have one you can create it at https://developer.bigcommerce.com/ Note: It is recommended to use this connector specifically to set up the Dynamics 365 Intelligent Order Management BigCommerce provider.

How to get credentials

BigCommerce requires an API token for authentication. You can generate a API token https://store-XYZ.mybigcommerce.com/manage/settings/auth/api-accounts and use that to configure the connector. Note: The XYZ is your store hash code.

Getting started with your connector

Configure the connection with the API token. To learn more about BigCommerce's API's read the public documentation: https://developer.bigcommerce.com/api-docs

Known issues and limitations

Details about API rate limits can be found the following documentation topic: https://developer.bigcommerce.com/api-docs/getting-started/best-practices#api-rate-limits Details about the platform limits can be found in the following documentation topic: https://developer.bigcommerce.com/api-docs/getting-started/best-practices#platform-limits

This connector was specifically developed to be used for Dynamics 365 Intelligent Order Management's BigCommerce provider integration. Support for usecases outside of Dynamics 365 Intelligent Order Management will be limited.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get All Customers

Returns a list of Customers. Optional filter parameters can be passed in.

Get All Orders

Gets all orders using the filter query.

Get An Order

Gets an order using order Id.

Get Order Shipping Addresses

Gets all shipping addresses on an order using the order Id.

Get Product By Id

Returns a single Product. Optional parameters can be passed in.

Get Products

Returns a list of Products. Optional filter parameters can be passed in.

List Order Products

Lists all order products on an order using the order Id.

Update An Order

Updates an Order. To learn more about creating or updating orders, see Orders Overview.

Update Product

Updates a Product.

Read-Only Fields

  • id
  • date_created
  • date_modified
  • calculated_price
  • base_variant_id

Get All Customers

Returns a list of Customers. Optional filter parameters can be passed in.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Items per page.
limit number

Items count per page. limit=50.

Filter items by ID.
id:in array

Filter items by ID. id:in=4,5,6.

Filter items by customer_group_id.
customer_group_id:in array

Filter items by customer_group_id. customer_group_id:in=5,6.

Filter items by date_modified.
date_modified date-time

Filter items by date_modified. date_modified=2018-09-05T13:45:03.

Filter items by minimum date_modified.
date_modified:min string

Filter items by mininum date_modified. date_modified:min=2019-09-04T:00:00:00 or date_modified:min=2019-09-04.

Filter items by maximum date_modified.
date_modified:max date-time

Filter items by maximum date_modified date_modified:max=2018-09-05T13:45:03 or date_modified:max=2019-09-04.

Indicates whether to include customer sub-resources.
include string

Indicates whether to include customer sub-resources:

  • addresses - customer addresses
  • storecredit - store credit
  • attributes - customer attributes and address attributes
  • formfields - customer and address form fields

include=addresses,storecredit,attributes,formfields.

Sort items.
sort string

Sort items by date_created, date_modified, or last_name:* date_created:asc - date created, ascending* date_created:desc - date created, descending* last_name:asc - last name, ascending* last_name:desc - last name, descending * date_modified:asc - date modified, ascending* date_modified:desc- date modified, descending Example: sort=last_name:asc.

Returns

Customer Collection Response
CustomerCollectionResponse

Get All Orders

Gets all orders using the filter query.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Min ID
min_id integer

The minimum order ID.

Maximum Order ID
max_id integer

The maximum order ID.

Min Total
min_total number

The minimum order total in float format.

Max Total
max_total number

The maximum order total in float format.

Customer ID
customer_id integer

Customer ID of the order.

Email
email string

The email of the customer.

Status ID
status_id integer

The staus ID of the order.

Cart ID
cart_id string

The cart ID of the order.

Payment Method
payment_method string

The payment method used on the order.

Min Date Created
min_date_created string

Minimum date the order was created in RFC-2822 or ISO-8601.

RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400'

ISO-8601: '2017-04-20T11:32:00.000-04:00'.

Max Date Created
max_date_created string

Maximum date the order was created in RFC-2822 or ISO-8601.

RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400'

ISO-8601: '2017-04-20T11:32:00.000-04:00'.

Min Date Modified
min_date_modified string

Minimum date the order was modified in RFC-2822 or ISO-8601.

RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400'

ISO-8601: '2017-04-20T11:32:00.000-04:00'.

Max Date Modified
max_date_modified string

Maximum date the order was modified in RFC-2822 or ISO-8601.

RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400'

ISO-8601: '2017-04-20T11:32:00.000-04:00'.

Page
page number

The page to return in the response.

Limit
limit number

Number of results to return.

Sort
sort string

Field and direction to sort orders. To specify the direction, add ':asc' or ':desc' to the end of the query parameter. E.g. 'sort=date_created:desc'.

Is Deleted
is_deleted boolean

If the order was deleted or archived.

Channel ID
channel_id boolean

The Channel ID of the Order.

Returns

Orders list returned in responses.

Get An Order

Gets an order using order Id.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Order ID
order_id True string

ID of the order.

Returns

Order object returned in responses.

order_Resp
order_Resp

Get Order Shipping Addresses

Gets all shipping addresses on an order using the order Id.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Order ID
order_id True string

ID of the order.

Page
page number

The page to return in the response.

Limit
limit number

Number of results to return.

Returns

Order shipping addresses returned in response.

Get Product By Id

Returns a single Product. Optional parameters can be passed in.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Product Id
product_id True integer

The ID of the Product to which the resource belongs.

include
include string

Sub-resources to include on a product, in a comma-separated list. If options or modifiers is used, results are limited to 10 per page.

include_fields
include_fields string

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fields
exclude_fields string

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Returns

Name Path Type Description
product_Full
data product_Full
Meta
meta object

Empty meta object; may be used later.

Get Products

Returns a list of Products. Optional filter parameters can be passed in.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Id
id integer

Filter items by id.

name
name string

Filter items by name.

upc
upc string

Filter items by upc.

price
price double

Filter items by price.

weight
weight double

Filter items by weight.

condition
condition string

Filter items by condition.

brand_id
brand_id integer

Filter items by brand_id.

date_modified
date_modified date-time

Filter items by date_modified.

date_modified:max
date_modified:max string

Filter items by date_modified. For example, date_modified:max=2020-06-15.

date_modified:min
date_modified:min string

Filter items by date_modified. For example, date_modified:min=2018-06-15.

date_last_imported
date_last_imported date-time

Filter items by date_last_imported.

date_last_imported:max
date_last_imported:max string

Filter items by date_last_imported. For example, date_last_imported:max=2020-06-15.

date_last_imported:min
date_last_imported:min string

Filter items by date_last_imported. For example, date_last_imported:min=2018-06-15.

is_visible
is_visible boolean

Filter items based on whether the product is currently visible on the storefront.

is_featured
is_featured string

Filter items by is_featured. 0 for true, 1 for false.

is_free_shipping
is_free_shipping integer

Filter items by is_free_shipping.

inventory_level
inventory_level integer

Filter items by inventory_level.

inventory_level:in
inventory_level:in integer

Inventory Level

inventory_level:not_in
inventory_level:not_in integer

Inventory Level NOT IN

inventory_level:min
inventory_level:min integer

Inventory Level MIN

inventory_level:max
inventory_level:max integer

Inventory Level MAX

inventory_level:greater
inventory_level:greater integer

Inventory Level GREATER

inventory_level:less
inventory_level:less integer

Inventory Level LESS

inventory_low
inventory_low integer

Filter items by inventory_low. Values: 1, 0.

out_of_stock
out_of_stock integer

Filter items by out_of_stock. To enable the filter, pass out_of_stock=1.

total_sold
total_sold integer

Filter items by total_sold.

type
type string

Filter items by type.

categories
categories integer

Filter items by categories. If a product is in more than one category, using this query will not return the product. Instead use categories:in=12.

keyword
keyword string

Filter items by keywords found in the name, description, or sku fields, or in the brand name.

keyword_context
keyword_context string

Set context used by the search algorithm to return results targeted towards the specified group. Use merchant to help merchants search their own catalog. Use shopper to return shopper-facing search results.

status
status integer

Filter items by status.

include
include string

Sub-resources to include on a product, in a comma-separated list. If options or modifiers is used, results are limited to 10 per page.

include_fields
include_fields string

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fields
exclude_fields string

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

availability
availability string

Filter items by availability. Values are: available, disabled, preorder.

page
page integer

Specifies the page number in a limited (paginated) list of products.

limit
limit integer

Controls the number of items per page in a limited (paginated) list of products.

direction
direction string

Sort direction. Acceptable values are: asc, desc.

sort
sort string

Field name to sort by. Note: Since id increments when new products are added, you can use that field to sort by product create date.

categories:in
categories:in integer

Filter items by categories. Use for products in multiple categories. For example, categories:in=12.

Returns

ProductCollectionResponse
ProductCollectionResponse

List Order Products

Lists all order products on an order using the order Id.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Order ID
order_id True string

ID of the order.

Page
page number

The page to return in the response.

Limit
limit number

Number of results to return.

Returns

Order products returned in responses.

Update An Order

Updates an Order. To learn more about creating or updating orders, see Orders Overview.

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

order_id
order_id True integer

ID of the order

object

Returns

Order object returned in responses.

order_Resp
order_Resp

Update Product

Updates a Product.

Read-Only Fields

  • id
  • date_created
  • date_modified
  • calculated_price
  • base_variant_id

Parameters

Name Key Required Type Description
Store Hash
store_hash True string

The store hash code.

Product Id
product_id True integer

The ID of the Product to which the resource belongs.

object
Include Fields
include_fields string

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

Returns

ProductResponse
ProductResponse

Definitions

address_Full

Name Path Type Description
first_name
first_name string

The first name of the customer address.

last_name
last_name string

The last name of the customer address.

company
company string

The company of the customer address.

address1
address1 string

The address 1 line.

address2
address2 string

The address 2 line.

city
city string

The city of the customer address.

state_or_province
state_or_province string

The state or province name

postal_code
postal_code string

The postal code of the customer address.

country_code
country_code string

The country code of the customer address.

phone
phone string

The phone number of the customer address.

Address Type
address_type string

The address type. Residential or Commercial

customer_id
customer_id integer

The customer ID.

id
id integer

The unique numeric ID of the address.

country
country string

The country name of the customer address.

Adjuster

The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

Adjuster
string

adjuster_Full

Adjuster for Complex Rules.

Name Path Type Description
Adjuster
adjuster Adjuster

The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

adjuster_value
adjuster_value double

The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

adjusters_Full

Name Path Type Description
adjuster_Full
price adjuster_Full

Adjuster for Complex Rules.

adjuster_Full
weight adjuster_Full

Adjuster for Complex Rules.

image_url
image_url string

The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file.

PurchasingDisabled
purchasing_disabled PurchasingDisabled

attribute_Full

Name Path Type Description
attribute_id
attribute_id integer

Attribute ID

attribute_value
attribute_value string

Attribute value

customer_id
customer_id integer

Customer ID

date_created
date_created date-time

The date the customer attribute was created

date_modified
date_modified date-time

The date the customer attribute was modified

id
id integer

Attribute value ID

billingAddress_Base

Billing Address properties common to all requests and responses.

Name Path Type Description
first_name
first_name string
last_name
last_name string
company
company string
street_1
street_1 string

Street address (first line).

street_2
street_2 string

Street address (second line).

city
city string
state
state string
zip
zip string

The billing address must include the zip code. The zip code must be two or more characters.

country
country string
country_iso2
country_iso2 string

2-letter ISO Alpha-2 code for the country.

phone
phone string

Recipient's telephone number.

email
email string

Recipient's email address.

billingAddress_Full

Required to create an order.

Name Path Type Description
billingAddress_Base
billingAddress billingAddress_Base

Billing Address properties common to all requests and responses.

form_fields
form_fields array of formFields

bulkPricingRule_Full

Common Bulk Pricing Rule properties

Name Path Type Description
id
id integer

Unique ID of the Bulk Pricing Rule. Read-Only.

quantity_min
quantity_min integer

The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. Required in /POST.

quantity_max
quantity_max integer

The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the quantity_min value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule. Required in /POST.

type
type string

The type of adjustment that is made. Values: price - the adjustment amount per product; percent - the adjustment as a percentage of the original price; fixed - the adjusted absolute price of the product. Required in /POST.

amount
amount integer

The discount can be a fixed dollar amount or a percentage. For a fixed dollar amount enter it as an integer and the response will return as an integer. For percentage enter the amount as the percentage divided by 100 using string format. For example 10% percent would be “.10”. The response will return as an integer. Required in /POST.

config_Full

The values for option config can vary based on the Modifier created.

Name Path Type Description
default_value
default_value string

(date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.

checked_by_default
checked_by_default boolean

(checkbox) Flag for setting the checkbox to be checked by default.

checkbox_label
checkbox_label string

(checkbox) Label displayed for the checkbox option.

date_limited
date_limited boolean

(date) Flag to limit the dates allowed to be entered on a date option.

date_limit_mode
date_limit_mode string

(date) The type of limit that is allowed to be entered on a date option.

date_earliest_value
date_earliest_value date

(date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.

date_latest_value
date_latest_value date

(date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.

file_types_mode
file_types_mode string

(file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.

file_types_supported
file_types_supported array of string

(file) The type of files allowed to be uploaded if the file_type_option is set to specific. Values: images - Allows upload of image MIME types (bmp, gif, jpg, jpeg, jpe, jif, jfif, jfi, png, wbmp, xbm, tiff). documents - Allows upload of document MIME types (txt, pdf, rtf, doc, docx, xls, xlsx, accdb, mdb, one, pps, ppsx, ppt, pptx, pub, odt, ods, odp, odg, odf). other - Allows file types defined in the file_types_other array.

file_types_other
file_types_other array of string

(file) A list of other file types allowed with the file upload option.

file_max_size
file_max_size integer

(file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.

text_characters_limited
text_characters_limited boolean

(text, multi_line_text) Flag to validate the length of a text or multi-line text input.

text_min_length
text_min_length integer

(text, multi_line_text) The minimum length allowed for a text or multi-line text option.

text_max_length
text_max_length integer

(text, multi_line_text) The maximum length allowed for a text or multi line text option.

text_lines_limited
text_lines_limited boolean

(multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.

text_max_lines
text_max_lines integer

(multi_line_text) The maximum number of lines allowed on a multi-line text input.

number_limited
number_limited boolean

(numbers_only_text) Flag to limit the value of a number option.

number_limit_mode
number_limit_mode string

(numbers_only_text) The type of limit on values entered for a number option.

number_lowest_value
number_lowest_value double

(numbers_only_text) The lowest allowed value for a number option if number_limited is true.

number_highest_value
number_highest_value double

(numbers_only_text) The highest allowed value for a number option if number_limited is true.

number_integers_only
number_integers_only boolean

(numbers_only_text) Flag to limit the input on a number option to whole numbers only.

product_list_adjusts_inventory
product_list_adjusts_inventory boolean

(product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.

product_list_adjusts_pricing
product_list_adjusts_pricing boolean

(product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.

product_list_shipping_calc
product_list_shipping_calc string

(product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.

coupons_Resource

Name Path Type Description
url
url string

URL of the coupons for api requests

resource
resource string

resource of the coupons

customer_Full

Name Path Type Description
email
email string

The email of the customer. Must be unique.

first_name
first_name string

The first name of the customer.

last_name
last_name string

The last name of the customer.

company
company string

The company of the customer.

phone
phone string

The phone number of the customer.

registration_ip_address
registration_ip_address string

The IP address from which this customer was registered.

notes
notes string

The customer notes.

tax_exempt_category
tax_exempt_category string

The tax exempt category code for the customer.

customer_group_id
customer_group_id integer

ID of the group which this customer belongs to.

id
id integer

The unique numeric ID of the customer.

date_modified
date_modified date-time

The date on which the customer was modified.

date_created
date_created date-time

The date of which the customer was created.

address_count
address_count integer

Total number of customer addresses.

attribute_count
attribute_count integer

Total number of customer attributes.

force_password_reset
authentication.force_password_reset boolean

If true, this customer will be forced to change password on next login.

addresses
addresses array of address_Full

Array of customer addresses. Limited to 10.

attributes
attributes array of attribute_Full

Array of customer attributes. Limited to 10.

store_credit_amounts
store_credit_amounts CustomerStoredCreditAmounts

Store credit.

accepts_product_review_abandoned_cart_emails
accepts_product_review_abandoned_cart_emails boolean

It determines if the customer is signed up to receive either product review or abandoned cart emails or recieve both emails.

customerChannelIds
channel_ids customerChannelIds

Array of channel ids the Customer has access to.

CustomerCollectionResponse

Name Path Type Description
data
data array of customer_Full

customerChannelIds

Array of channel ids the Customer has access to.

Name Path Type Description
Items
integer

CustomerStoredCreditAmounts

Store credit.

Name Path Type Description
amount
amount float

customUrl_Full

The custom URL for the product on the storefront.

Name Path Type Description
url
url string

Product URL on the storefront.

is_customized
is_customized boolean

Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

formFields

Read-Only. If you have required address form fields they will need to be set as optional before creating an order via API.

Name Path Type Description
name
name string

Read-Only. If you have required address form fields they will need to be set as optional before creating an order via API.

value
value string

Read-Only. If you have required address form fields they will need to be set as optional before creating an order via API.

Pagination links for the previous and next parts of the whole collection.

Name Path Type Description
previous
previous string

Link to the previous page returned in the response.

current
current string

Link to the current page returned in the response.

next
next string

Link to the next page returned in the response.

metaCollection_Full

Data about the response, including pagination and collection totals.

Name Path Type Description
pagination_Full
pagination pagination_Full

Data about the response, including pagination and collection totals.

order_Resp

Order object returned in responses.

Name Path Type Description
id
id integer

Read-only. The ID of the order.

date_modified
date_modified string

A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT operation. RFC-2822

date_shipped
date_shipped string

A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT operation. RFC-2822

cart_id
cart_id string

The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

status
status string

The status will include one of the (string, optiona) - values defined under Order Statuses. This value is read-only. Do not attempt to modify or set this value in a POST or PUT operation.

subtotal_tax
subtotal_tax string

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (Float, Float-As-String, Integer)

shipping_cost_tax
shipping_cost_tax string

A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (Float, Float-As-String, Integer)

shipping_cost_tax_class_id
shipping_cost_tax_class_id integer

Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.)

handling_cost_tax
handling_cost_tax string

A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (Float, Float-As-String, Integer)

handling_cost_tax_class_id
handling_cost_tax_class_id integer

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.)

wrapping_cost_tax
wrapping_cost_tax string

A read-only value. Do not attempt to modify or set this value in a POST or PUT operation. (Float, Float-As-String, Integer)

wrapping_cost_tax_class_id
wrapping_cost_tax_class_id integer

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.)

PaymentStatus
payment_status PaymentStatus

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation.

store_credit_amount
store_credit_amount string

Represents the store credit that the shopper has redeemed on this individual order. This is a read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)

gift_certificate_amount
gift_certificate_amount string

A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)

currency_id
currency_id integer

The display currency ID. May be different from transactional currency. A read-only value. Do not pass in a POST or PUT.

currency_code
currency_code string

The currency code of the display currency used to present prices on the storefront. A read-only value. Do not pass in a POST or PUT.

currency_exchange_rate
currency_exchange_rate string

The exchange rate between the store's default currency and the display currency. A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)

default_currency_id
default_currency_id integer

The transactional currency ID. A read-only value. Do not pass in a POST or PUT.

coupon_discount
coupon_discount string

A read-only value. Do not pass in a POST or PUT. (Float, Float-As-String, Integer)

shipping_address_count
shipping_address_count double

The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT.

is_email_opt_in
is_email_opt_in boolean

Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.

order_source
order_source string

Orders submitted via the store's website will include a www value. Orders submitted via the API will be set to external. A read-only value. Do not pass in a POST or PUT.

products_Resource
products products_Resource
shippingAddress_Resource
shipping_addresses shippingAddress_Resource
coupons_Resource
coupons coupons_Resource
status_id
status_id integer

The staus ID of the order.

base_handling_cost
base_handling_cost string

The value of the base handling cost. (Float, Float-As-String, Integer)

base_shipping_cost
base_shipping_cost string

The value of the base shipping cost. (Float, Float-As-String, Integer)

base_wrapping_cost
base_wrapping_cost string

The value of the base wrapping cost. (Float, Float-As-String, Integer)

billingAddress_Full
billing_address billingAddress_Full

Required to create an order.

channel_id
channel_id integer

Shows where the order originated. The channel_id will default to 1.

customer_id
customer_id double
customer_message
customer_message string

Message that the customer entered (number, optional) -o the Order Comments box during checkout.

date_created
date_created string

The date this order was created. If not specified, will default to the current time. The date should be in RFC 2822 format.

default_currency_code
default_currency_code string

The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled.

discount_amount
discount_amount string

Amount of discount for this transaction. (Float, Float-As-String, Integer)

ebay_order_id
ebay_order_id string

If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be 0.

external_id
external_id string

ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order.This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field 'external_id' cannot be written to. Please remove it from your request before trying again. It can not be overwritten once set.

external_source
external_source string

For orders submitted or modified via the API, using a PUT or POST operation, you can optionally pass in a value identifying the system used to generate the order. For example: POS. Otherwise, the value will be null.

geoip_country
geoip_country string

The full name of the country where the customer made the purchase, based on the IP.

geoip_country_iso2
geoip_country_iso2 string

The country where the customer made the purchase, in ISO2 format, based on the IP.

handling_cost_ex_tax
handling_cost_ex_tax string

The value of the handling cost, excluding tax. (Float, Float-As-String, Integer)

handling_cost_inc_tax
handling_cost_inc_tax string

The value of the handling cost, including tax. (Float, Float-As-String, Integer)

ip_address
ip_address string

IP Address of the customer, if known.

is_deleted
is_deleted boolean

Indicates whether the order was deleted (archived). Set to to true, to archive an order.

items_shipped
items_shipped double

The number of items that have been shipped.

items_total
items_total double

The total number of items in the order.

order_is_digital
order_is_digital boolean

Whether this is an order for digital products.

PaymentMethod
payment_method PaymentMethod

The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.

payment_provider_id
payment_provider_id string

The external Transaction ID/Payment ID within this order's payment provider (if a payment provider was used).

refunded_amount
refunded_amount string

The amount refunded from this transaction. (Float, Float-As-String, Integer)

shipping_cost_ex_tax
shipping_cost_ex_tax string

The value of shipping cost, excluding tax. (Float, Float-As-String, Integer)

shipping_cost_inc_tax
shipping_cost_inc_tax string

The value of shipping cost, including tax. (Float, Float-As-String, Integer)

staff_notes
staff_notes string

Any additional notes for staff.

subtotal_ex_tax
subtotal_ex_tax string

Override value for subtotal excluding tax. If specified, the field subtotal_inc_tax is also required. (Float, Float-As-String, Integer)

subtotal_inc_tax
subtotal_inc_tax string

Override value for subtotal including tax. If specified, the field subtotal_ex_tax is also required. (Float, Float-As-String, Integer)

TaxProviderId
tax_provider_id TaxProviderId

BasicTaxProvider - Tax is set to manual.

AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API. Used for Avalara.

"" (blank) - When the tax provider is unknown. This includes legacy orders and orders previously created via API. This can be set when creating an order using a POST.

customer_locale
customer_locale string

The customer's locale

total_ex_tax
total_ex_tax string

Override value for the total, excluding tax. If specified, the field total_inc_tax is also required. (Float, Float-As-String, Integer)

total_inc_tax
total_inc_tax string

Override value for the total, including tax. If specified, the field total_ex_tax is also required. (Float, Float-As-String, Integer)

wrapping_cost_ex_tax
wrapping_cost_ex_tax string

The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)

wrapping_cost_inc_tax
wrapping_cost_inc_tax string

The value of the wrapping cost, including tax. (Float, Float-As-String, Integer)

orderCollection_Resp

Orders list returned in responses.

Name Path Type Description
order_Resp
order_Resp

Order object returned in responses.

orderProduct_Resp

Order product returned in responses.

Name Path Type Description
id
id integer

Numeric ID of this product within this order.

order_id
order_id integer

Numeric ID of the associated order.

product_id
product_id integer

Numeric ID of the product.

order_address_id
order_address_id integer

Numeric ID of the associated order address.

name
name string

Alias for name_customer - The product name that is shown to customer in storefront.

sku
sku string

User-defined product code/stock keeping unit (SKU).

type
type string

Type of product.

base_price
base_price string

The product's base price. (Float, Float-As-String, Integer).

price_ex_tax
price_ex_tax string

The product's price excluding tax. (Float, Float-As-String, Integer).

price_inc_tax
price_inc_tax string

The product's price including tax. (Float, Float-As-String, Integer).

price_tax
price_tax string

Amount of tax applied to a single product. Price tax is calculated as: 'price_tax = price_inc_tax - price_ex_tax' (Float, Float-As-String, Integer).

base_total
base_total string

Total base price. (Float, Float-As-String, Integer).

total_ex_tax
total_ex_tax string

Total base price excluding tax. (Float, Float-As-String, Integer).

total_inc_tax
total_inc_tax string

Total base price including tax. (Float, Float-As-String, Integer).

total_tax
total_tax string

Total tax applied to products. For example, if quantity if 2, base price is 5 and tax rate is 10%. price_tax will be $.50 and total_tax will be $1.00. If there is a manual discount applied total_tax is calcuted as the following: '(price_ex_tax - discount)*tax_rate=total_tax' (Float, Float-As-String, Integer).

quantity
quantity number

Quantity of the product ordered.

base_cost_price
base_cost_price string

The product's cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only.

cost_price_inc_tax
cost_price_inc_tax string

The product's cost price including tax. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only.

cost_price_ex_tax
cost_price_ex_tax string

The products cost price excluding tax. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only.

weight
weight string

Weight of the product. (Float, Float-As-String, Integer).

cost_price_tax
cost_price_tax string

Tax applied to the product's cost price. (Float, Float-As-String, Integer) The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only.

is_refunded
is_refunded boolean

Whether the product has been refunded.

refunded_amount
refunded_amount string

The amount refunded from this transaction. (Float, Float-As-String, Integer).

return_id
return_id number

Numeric ID for the refund.

wrapping_name
wrapping_name string

Name of gift-wrapping option.

base_wrapping_cost
base_wrapping_cost string

The value of the base wrapping cost. (Float, Float-As-String, Integer).

wrapping_cost_ex_tax
wrapping_cost_ex_tax string

The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer).

wrapping_cost_inc_tax
wrapping_cost_inc_tax string

The value of the wrapping cost, including tax. (Float, Float-As-String, Integer).

wrapping_cost_tax
wrapping_cost_tax string

Tax applied to gift-wrapping option. (Float, Float-As-String, Integer).

wrapping_message
wrapping_message string

Message to accompany gift-wrapping option.

quantity_shipped
quantity_shipped number

Quantity of this item shipped.

event_name
event_name string

Name of promotional event/delivery date.

event_date
event_date date

Date of the promotional event/scheduled delivery.

fixed_shipping_cost
fixed_shipping_cost string

Fixed shipping cost for this product. (Float, Float-As-String, Integer).

ebay_item_id
ebay_item_id string

Item ID for this product on eBay.

ebay_transaction_id
ebay_transaction_id string

Transaction ID for this product on eBay.

option_set_id
option_set_id integer

Numeric ID of the option set applied to the product.

parent_order_product_id
parent_order_product_id integer

ID of a parent product.

is_bundled_product
is_bundled_product boolean

Whether this product is bundled with other products.

bin_picking_number
bin_picking_number string

Bin picking number for the physical product.

applied_discounts
applied_discounts array of object

Array of objects containing discounts applied to the product.

id
applied_discounts.id string

Name of the coupon applied to order.

amount
applied_discounts.amount string

Amount of the discount.(Float, Float-As-String, Integer).

name
applied_discounts.name string

Name of the coupon. Manual Discount when creating a manual discount.

code
applied_discounts.code string

Coupon Code. There is no code when creating a manual discount.

target
applied_discounts.target string

Determines if the discount if discount was applied at the Order or Product level. Read Only.

product_options
product_options array of object

Array of product option objects.

id
product_options.id integer

The unique numerical ID of the option; increments sequentially.

option_id
product_options.option_id integer

Numeric ID of the associated option.

order_product_id
product_options.order_product_id integer

Order product Id.

product_option_id
product_options.product_option_id integer

Product option Id.

display_name
product_options.display_name string

Alias for display_name_customer. The product option name that is shown to customer in the storefront.

display_value
product_options.display_value string

Alias for display_value_customer. The product option value that is shown to customer in storefront.

value
product_options.value string

This value is used to access the Customer File Upload.

type
product_options.type string

Option Type.

name
product_options.name string

The option's name, as used internally. Must be unique.

display_style
product_options.display_style string

How it is displayed on the storefront. Examples include Drop-down, radio buttons, or rectangles.

display_name_customer
product_options.display_name_customer string

The product option name that is shown to customer in storefront.

display_name_merchant
product_options.display_name_merchant string

The product option name that is shown to merchant in Control Panel.

display_value_customer
product_options.display_value_customer string

The product option value that is shown to customer in storefront.

display_value_merchant
product_options.display_value_merchant string

The product option value that is shown to merchant in Control Panel.

external_id
external_id string

ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order.This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field 'external_id' cannot be written to. Please remove it from your request before trying again. It can not be overwritten once set.

upc
upc string

Universal Product Code. Can be written to for custom products and catalog products.

variant_id
variant_id integer

Products variant_id. PUT or POST. This field is not available for custom products.

name_customer
name_customer string

The product name that is shown to customer in storefront.

name_merchant
name_merchant string

The product name that is shown to merchant in Control Panel.

orderProductsCollection_Resp

Order products returned in responses.

Name Path Type Description
orderProduct_Resp
orderProduct_Resp

Order product returned in responses.

orderShippingAddress_Resp

Order shipping address returned in response.

Name Path Type Description
id
id integer

ID of this shipping address.

order_id
order_id integer

ID of the order.

items_total
items_total number

The total number of items in the order.

items_shipped
items_shipped number

The number of items that have been shipped.

base_cost
base_cost string

The base value of the order's items. (Float, Float-As-String, Integer).

cost_ex_tax
cost_ex_tax string

The value of the order's items, excluding tax. (Float, Float-As-String, Integer).

cost_inc_tax
cost_inc_tax string

The value of the order's items, including tax. (Float, Float-As-String, Integer).

cost_tax
cost_tax string

The tax amount on the order. (Float, Float-As-String, Integer).

cost_tax_class_id
cost_tax_class_id integer

The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled).

handling_cost_ex_tax
handling_cost_ex_tax string

The handling charge, excluding tax. (Float, Float-As-String, Integer).

handling_cost_inc_tax
handling_cost_inc_tax string

The handling charge, including tax. (Float, Float-As-String, Integer).

handling_cost_tax
handling_cost_tax string
handling_cost_tax_class_id
handling_cost_tax_class_id integer

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store).

shipping_zone_id
shipping_zone_id number

Numeric ID of the shipping zone.

shipping_zone_name
shipping_zone_name string

Name of the shipping zone.

form_fields
form_fields array of formFields
shippingQuotes_Resource
shipping_quotes shippingQuotes_Resource
shippingAddress_Base
shipping_addresses shippingAddress_Base

Shipping Address properties common to all requests and responses.

orderShippingAddressCollection_Resp

Order shipping addresses returned in response.

Name Path Type Description
orderShippingAddress_Resp
orderShippingAddress_Resp

Order shipping address returned in response.

pagination_Full

Data about the response, including pagination and collection totals.

Name Path Type Description
total
total integer

Total number of items in the result set.

count
count integer

Total number of items in the collection response.

per_page
per_page integer

The amount of items returned in the collection per page, controlled by the limit parameter.

current_page
current_page integer

The page you are currently on within the collection.

total_pages
total_pages integer

The total number of pages in the collection.

Links
links Links

Pagination links for the previous and next parts of the whole collection.

product_Base

Name Path Type Description
name
name string

The product name.

type
type string

The product type. One of: physical - a physical stock unit, digital - a digital download.

sku
sku string

User defined product code/stock keeping unit (SKU).

description
description string

The product description, which can include HTML formatting.

weight
weight double

Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store

width
width double

Width of the product, which can be used when calculating shipping costs.

depth
depth double

Depth of the product, which can be used when calculating shipping costs.

height
height double

Height of the product, which can be used when calculating shipping costs.

price
price double

The price of the product. The price should include or exclude tax, based on the store settings.

cost_price
cost_price double

The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.

retail_price
retail_price double

The retail cost of the product. If entered, the retail cost price will be shown on the product page.

sale_price
sale_price double

If entered, the sale price will be used instead of value in the price field when calculating the product's cost.

map_price
map_price double

Minimum Advertised Price

tax_class_id
tax_class_id integer

The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)

product_tax_code
product_tax_code string

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. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation.

categories
categories array of integer

An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values.

brand_id
brand_id integer

A product can be added to an existing brand during a product /PUT or /POST.

inventory_level
inventory_level integer

Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect.

inventory_warning_level
inventory_warning_level integer

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
inventory_tracking string

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
fixed_cost_shipping_price double

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
is_free_shipping boolean

Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.

is_visible
is_visible boolean

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
is_featured boolean

Flag to determine whether the product should be included in the featured products panel when viewing the store.

related_products
related_products array of integer

An array of IDs for the related products.

warranty
warranty string

Warranty information displayed on the product page. Can include HTML formatting.

bin_picking_number
bin_picking_number string

The BIN picking number for the product.

layout_file
layout_file string

The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied.

upc
upc string

The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.

search_keywords
search_keywords string

A comma-separated list of keywords that can be used to locate the product when searching the store.

availability
availability string

Availability of the product. Availability options are: available - the product can be purchased on the storefront; disabled - the product is listed in the storefront, but cannot be purchased; preorder - the product is listed for pre-orders.

availability_description
availability_description string

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.'

gift_wrapping_options_type
gift_wrapping_options_type string

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
gift_wrapping_options_list array of integer

A list of gift-wrapping option IDs.

sort_order
sort_order integer

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
condition string

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
is_condition_shown boolean

Flag used to determine whether the product condition is shown to the customer on the product page.

order_quantity_minimum
order_quantity_minimum integer

The minimum quantity an order must contain, to be eligible to purchase this product.

order_quantity_maximum
order_quantity_maximum integer

The maximum quantity an order can contain when purchasing the product.

page_title
page_title string

Custom title for the product page. If not defined, the product name will be used as the meta title.

meta_keywords
meta_keywords array of string

Custom meta keywords for the product page. If not defined, the store's default keywords will be used.

meta_description
meta_description string

Custom meta description for the product page. If not defined, the store's default meta description will be used.

view_count
view_count integer

The number of times the product has been viewed.

preorder_release_date
preorder_release_date date-time

Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.

preorder_message
preorder_message string

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
is_preorder_only boolean

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
is_price_hidden boolean

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
price_hidden_label string

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

customUrl_Full
custom_url customUrl_Full

The custom URL for the product on the storefront.

open_graph_type
open_graph_type string

Type of product, defaults to product.

open_graph_title
open_graph_title string

Title of the product, if not specified the product name will be used instead.

open_graph_description
open_graph_description string

Description to use for the product, if not specified then the meta_description will be used instead.

open_graph_use_meta_description
open_graph_use_meta_description boolean

Flag to determine if product description or open graph description is used.

open_graph_use_product_name
open_graph_use_product_name boolean

Flag to determine if product name or open graph name is used.

open_graph_use_image
open_graph_use_image boolean

Flag to determine if product image or open graph image is used.

brand_name or brand_id
brand_name or brand_id string

The brand can be created during a product PUT or POST request. If the brand already exists then the product will be added. If not the brand will be created and the product added. If using brand_name it performs a fuzzy match and adds the brand. eg. "Common Good" and "Common good" are the same. Brand name does not return as part of a product response. Only the brand_id.

gtin
gtin string

Global Trade Item Number

mpn
mpn string

Manufacturer Part Number

reviews_rating_sum
reviews_rating_sum integer

The total rating for the product.

reviews_count
reviews_count integer

The number of times the product has been rated.

total_sold
total_sold integer

The total quantity of this product sold.

custom_fields
custom_fields array of productCustomField_Put
bulk_pricing_rules
bulk_pricing_rules array of bulkPricingRule_Full
images
images array of productImage_Full
videos
videos array of productVideo_Full

product_Full

Name Path Type Description
product_Base
schema product_Base
date_created
date_created date-time

The date on which the product was created.

date_modified
date_modified date-time

The date on which the product was modified.

id
id integer

ID of the product. Read Only.

base_variant_id
base_variant_id integer

The unique identifier of the base variant associated with a simple product. This value is null for complex products.

calculated_price
calculated_price double

The price of the product as seen on the storefront. It will be equal to the sale_price, if set, and the price if there is not a sale_price.

options
options array of productOption_Base
modifiers
modifiers array of productModifier_Full
option_set_id
option_set_id integer

Indicates that the product is in an Option Set (legacy V2 concept).

option_set_display
option_set_display string

Legacy template setting which controls if the option set shows up to the side of or below the product image and description.

productVariant_Full
variants productVariant_Full

ProductCollectionResponse

Name Path Type Description
data
data array of product_Full
metaCollection_Full
meta metaCollection_Full

Data about the response, including pagination and collection totals.

productCustomField_Put

Gets custom fields associated with a product. These allow you to specify additional information that will appear on the product's page, such as a book's ISBN or a DVD's release date.

Name Path Type Description
id
id integer

The unique numeric ID of the custom field; increments sequentially. Required to update existing custom field in /PUT request. Read-Only

name
name string

The name of the field, shown on the storefront, orders, etc. Required for /POST

value
value string

The name of the field, shown on the storefront, orders, etc. Required for /POST

productImage_Full

Common ProductImage properties.

Name Path Type Description
image_file
image_file string

The local path to the original image file uploaded to BigCommerce.

is_thumbnail
is_thumbnail boolean

Flag for identifying whether the image is used as the product's thumbnail.

sort_order
sort_order integer

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.

description
description string

The description for the image.

image_url
image_url string

Must be a fully qualified URL path, including protocol. Limit of 8MB per file.

id
id integer

The unique numeric ID of the image; increments sequentially.

product_id
product_id integer

The unique numeric identifier for the product with which the image is associated.

url_zoom
url_zoom string

The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled.

url_standard
url_standard string

The standard URL for this image. By default, this is used for product-page images.

url_thumbnail
url_thumbnail string

The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.

url_tiny
url_tiny string

The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page.

date_modified
date_modified date-time

The date on which the product image was modified.

productModifier_Base

Common Modifier properties.

Name Path Type Description
type
type string

BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. Required in a /POST.

required
required boolean

Whether or not this modifer is required or not at checkout. Required in a /POST.

sort_order
sort_order integer

The order the modifiers display on the product detail page.

config_Full
config config_Full

The values for option config can vary based on the Modifier created.

display_name
display_name string

The name of the option shown on the storefront.

productModifier_Full

Product Modifier

Name Path Type Description
productModifier_Base
schema productModifier_Base

Common Modifier properties.

id
id integer

The unique numeric ID of the modifier; increments sequentially.

product_id
product_id integer

The unique numeric ID of the product to which the option belongs.

name
name string

The unique option name. Auto-generated from the display name, a timestamp, and the product ID.

option_values
option_values array of productModifierOptionValue_Full

productModifierOptionValue_Full

Product Modifer option_value.

Name Path Type Description
is_default
is_default boolean

The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

label
label string

The text display identifying the value on the storefront. Required in a /POST.

sort_order
sort_order integer

The order in which the value will be displayed on the product page. Required in a /POST.

value_data
value_data object

Extra data describing the value, based on the type of option or modifier with which the value is associated. The swatch type option can accept an array of colors, with up to three hexidecimal color keys; or an image_url, which is a full image URL path including protocol. The product list type option requires a product_id. The checkbox type option requires a boolean flag, called checked_value, to determine which value is considered to be the checked state. If no data is available, returns null.

adjusters_Full
adjusters adjusters_Full
id
id integer

The unique numeric ID of the value; increments sequentially.

option_id
option_id integer

productOption_Base

Common Option properties.

Name Path Type Description
id
id integer

The unique numerical ID of the option, increments sequentially.

product_id
product_id integer

The unique numerical ID of the product to which the option belongs.

display_name
display_name string

The name of the option shown on the storefront.

type
type string

The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.

productOptionConfig_Full
config productOptionConfig_Full

The values for option config can vary based on the Modifier created.

sort_order
sort_order integer

Order in which the option is displayed on the storefront.

productOptionOptionValue_Full
option_values productOptionOptionValue_Full

Product Option option_value.

productOptionConfig_Full

The values for option config can vary based on the Modifier created.

Name Path Type Description
default_value
default_value string

(date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string.

checked_by_default
checked_by_default boolean

(checkbox) Flag for setting the checkbox to be checked by default.

checkbox_label
checkbox_label string

(checkbox) Label displayed for the checkbox option.

date_limited
date_limited boolean

(date) Flag to limit the dates allowed to be entered on a date option.

date_limit_mode
date_limit_mode string

(date) The type of limit that is allowed to be entered on a date option.

date_earliest_value
date_earliest_value date

(date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.

date_latest_value
date_latest_value date

(date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.

file_types_mode
file_types_mode string

(file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.

file_types_supported
file_types_supported array of string

(file) The type of files allowed to be uploaded if the file_type_option is set to specific. Values: images - Allows upload of image MIME types (bmp, gif, jpg, jpeg, jpe, jif, jfif, jfi, png, wbmp, xbm, tiff). documents - Allows upload of document MIME types (txt, pdf, rtf, doc, docx, xls, xlsx, accdb, mdb, one, pps, ppsx, ppt, pptx, pub, odt, ods, odp, odg, odf). other - Allows file types defined in the file_types_other array.

file_types_other
file_types_other array of string

(file) A list of other file types allowed with the file upload option.

file_max_size
file_max_size integer

(file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.

text_characters_limited
text_characters_limited boolean

(text, multi_line_text) Flag to validate the length of a text or multi-line text input.

text_min_length
text_min_length integer

(text, multi_line_text) The minimum length allowed for a text or multi-line text option.

text_max_length
text_max_length integer

(text, multi_line_text) The maximum length allowed for a text or multi line text option.

text_lines_limited
text_lines_limited boolean

(multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.

text_max_lines
text_max_lines integer

(multi_line_text) The maximum number of lines allowed on a multi-line text input.

number_limited
number_limited boolean

(numbers_only_text) Flag to limit the value of a number option.

number_limit_mode
number_limit_mode string

(numbers_only_text) The type of limit on values entered for a number option.

number_lowest_value
number_lowest_value double

(numbers_only_text) The lowest allowed value for a number option if number_limited is true.

number_highest_value
number_highest_value double

(numbers_only_text) The highest allowed value for a number option if number_limited is true.

number_integers_only
number_integers_only boolean

(numbers_only_text) Flag to limit the input on a number option to whole numbers only.

product_list_adjusts_inventory
product_list_adjusts_inventory boolean

(product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.

product_list_adjusts_pricing
product_list_adjusts_pricing boolean

(product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.

product_list_shipping_calc
product_list_shipping_calc string

(product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: none - don't adjust; weight - use shipping weight only; package - use weight and dimensions.

productOptionOptionValue_Full

Product Option option_value.

Name Path Type Description
is_default
is_default boolean

The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

label
label string

The text display identifying the value on the storefront. Required in a /POST.

sort_order
sort_order integer

The order in which the value will be displayed on the product page. Required in a /POST.

value_data
value_data object

Extra data describing the value, based on the type of option or modifier with which the value is associated. The swatch type option can accept an array of colors, with up to three hexidecimal color keys; or an image_url, which is a full image URL path including protocol. The product list type option requires a product_id. The checkbox type option requires a boolean flag, called checked_value, to determine which value is considered to be the checked state. If no data is available, returns null.

id
id integer

The unique numeric ID of the value; increments sequentially.

ProductResponse

Name Path Type Description
product_Full
data product_Full
meta
meta object

Empty meta object; may be used later.

products_Resource

Name Path Type Description
url
url string
resource
resource string

productVariant_Full

Name Path Type Description
cost_price
cost_price double

The cost price of the variant. Not affected by Price List prices.

price
price double

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.

sale_price
sale_price double

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.

retail_price
retail_price double

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.

weight
weight double

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.

width
width double

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.

height
height double

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.

depth
depth double

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.

is_free_shipping
is_free_shipping boolean

Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.

fixed_cost_shipping_price
fixed_cost_shipping_price double

A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.

purchasing_disabled
purchasing_disabled boolean

If true, this variant will not be purchasable on the storefront.

purchasing_disabled_message
purchasing_disabled_message string

If purchasing_disabled is true, this message should show on the storefront when the variant is selected.

upc
upc string

The UPC code used in feeds for shopping comparison sites and external channel integrations.

inventory_level
inventory_level integer

Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.

inventory_warning_level
inventory_warning_level integer

When the variant hits this inventory level, it is considered low stock.

bin_picking_number
bin_picking_number string

Identifies where in a warehouse the variant is located.

mpn
mpn string

The Manufacturer Part Number (MPN) for the variant.

id
id integer
product_id
product_id integer
sku
sku string
sku_id
sku_id integer

Read-only reference to v2 API's SKU ID. Null if it is a base variant.

option_values
option_values array of productVariantOptionValue_Full

Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant.

calculated_price
calculated_price double

The price of the variant as seen on the storefront. This price takes into account sale_price and any price adjustment rules that are applicable to this variant.

calculated_weight
calculated_weight double

productVariantOptionValue_Full

Name Path Type Description
option_display_name
option_display_name string

The name of the option.

label
label string

The label of the option value.

id
id integer

option_value ID.

option_id
option_id integer

option ID.

productVideo_Base

The model for a POST to create a video on a product.

Name Path Type Description
title
title string

The title for the video. If left blank, this will be filled in according to data on a host site.

description
description string

The description for the video. If left blank, this will be filled in according to data on a host site.

sort_order
sort_order integer

The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a sort_order the same as or greater than the video's new sort_order value will have their sort_orders reordered.

type
type string

The video type (a short name of a host site).

video_id
video_id string

The ID of the video on a host site.

productVideo_Full

A product video model.

Name Path Type Description
productVideo_Base
schema productVideo_Base

The model for a POST to create a video on a product.

id
id integer

The unique numeric ID of the product video; increments sequentially.

product_id
product_id integer

The unique numeric identifier for the product with which the image is associated.

length
length string

Length of the video. This will be filled in according to data on a host site.

PurchasingDisabled

Name Path Type Description
status
status boolean

Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value.

message
message string

The message displayed on the storefront when the purchasing disabled status is true.

shippingAddress_Base

Shipping Address properties common to all requests and responses.

Name Path Type Description
first_name
first_name string
last_name
last_name string
company
company string
street_1
street_1 string

Street address (first line).

street_2
street_2 string

Street address (second line).

city
city string
state
state string
zip
zip string

Zip or postal code, as a string.

country
country string
country_iso2
country_iso2 string

2-letter ISO Alpha-2 code for the country.

phone
phone string

Recipient's telephone number.

email
email string

Recipient's email address.

shipping_method
shipping_method string

Text code identifying the BigCommerce shipping module selected by the customer.

shippingAddress_Resource

Name Path Type Description
url
url string

URL of the shipping address for api requests

resource
resource string

shippingQuotes_Resource

Name Path Type Description
url
url string

This URL will return a 204 for shipping quotes. To return shipping quotes:'/shipping_addresses/shipping_address_id/shipping_quotes'.

resource
resource string

This URL will return a 204 for shipping quotes. To return shipping quotes:'/shipping_addresses/shipping_address_id/shipping_quotes'.

PaymentStatus

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation.

A read-only value. Do not attempt to set or modify this value in a POST or PUT operation.

PaymentStatus
string

PaymentMethod

The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.

The payment method for this order. Can be one of the following: Manual, Credit Card, cash, Test Payment Gateway, etc.

PaymentMethod
string

TaxProviderId

BasicTaxProvider - Tax is set to manual.

AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API. Used for Avalara.

"" (blank) - When the tax provider is unknown. This includes legacy orders and orders previously created via API. This can be set when creating an order using a POST.

BasicTaxProvider - Tax is set to manual.

AvaTaxProvider - This is for when the tax provider has been set to automatic and the order was NOT created by the API. Used for Avalara.

"" (blank) - When the tax provider is unknown. This includes legacy orders and orders previously created via API. This can be set when creating an order using a POST.

TaxProviderId
string