BigCommerce Connector Objects

Name	Description
Blogposts	Returns all Blog Posts.
BlogTags	Returns a list of Blog Tags.
Brands	Gets the collection of brands.
Categories	Returns Product Categories.
ChannelListings	Returns a list of all Channel Listings for a specific channel
Channels	GET,CREATE,UPDATE Channels
Coupons	Create,list,update or delete coupons.
Currencies	Returns data from Currencies table.
CustomerAddresses	Returns a list of Customer Addresses. Returns the addresses belonging to a customer.
CustomerGroups	Returns a list of Customer Groups.
Customers	Returns data from Customers table.
DownloadConsignments	Returns consignments and their corresponding downloads.
EmailConsignments	Returns consignments and their corresponding emails.
GiftCertificates	Lists all gift certificates.
OrderCoupons	Lists all order coupons.
OrderItemOptionValues	Returns data from OrderItems table.
OrderItems	Returns Items ordered for every order.
OrderMessages	Gets the messages associated with an order.
OrderRefunds	Returns a list of refunds.
OrderRefundsItems	List of Items refunded.
OrderRefundsPayments	Refund payments made to payment providers.
Orders	Returns data from Orders table.
OrderShipments	Returns shipments and their corresponding orders.
OrderShippingAddresses	Returns shipping addresses and their corresponding orders.
OrderStatuses	Returns order statuses.
OrderTaxes	Gets all order taxes related to an order.
Pages	Lists all pages.
PaymentMethods	Lists all payment methods.
PickupConsignments	Returns consignments and their corresponding pickups.
PriceListAssignments	Returns an array of Price List Assignments matching a particular Customer Group and Price List and Channel.
PriceListRecords	Returns a collection of price List records
PriceLists	Returns a collection of price records
ProductBulkPricingRules	Returns bulk pricing rules applied to a product.
ProductCustomFields	Lists all tax classes.
ProductImages	Returns images registered for products.
ProductMetafields	Returns a list of Product Metafields.
ProductOptions	Returns data from Products table.
ProductOptionValues	Returns data from Products table.
ProductReviews	Returns reviews registered for products.
ProductRules	Returns rules that modify the properties of a product, such as weight, price, and product image.
Products	Returns data from products table.
ProductSkus	Returns Stock Keeping Unit identifiers associated with products or product options.
ProductVariants	Returns data from Products table.
ProductVariantValues	Returns data from Products table.
ProductVideos	Returns Embedded videos displayed on product listings.
Redirects	Lists all redirect URLs.
ShipmentItems	Returns data from Items within a shipment.
ShippingConsignmentQuotes	Gets all shipping quotes persisted on an order for a shipping consignment.
ShippingConsignments	Returns consignments and their corresponding shipping orders.
ShippingMethods	Lists all shipping methods.
ShippingZones	Lists all shipping zones.
Stores	Lists all Stores.
TaxClasses	Lists all tax classes.
Transactions	Lists all transactions.

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Id of the blogpost
Title	String	False	No	Title of this blog post.
URL	String	False	No	URL for the public blog post.
PreviewURL	String	False	No	URL to preview the blog post.
Body	String	False	No	Text body of the blog post.
Summary	String	False	No	Summary of the blog post.
IsPublished	Boolean	False	No	Whether the blog post is published.
PublishedDate	Datetime	False	No	Date when the blogpost was published.
PublishedTimezone	String	False	No	Timezone when the blogpost was published.
PublishedTimezoneType	String	False	No	Type of the timezone.
PublishedDateISO	String	False	No	Published date in ISO8601 format.
MetaDescription	String	False	No	Description text for this blog posts meta element.
MetaKeywords	String	False	No	Keywords for this blog posts meta element.
Author	String	False	No	Name of the blog posts author.
ThumbnailPath	String	False	No	Local path to a thumbnail image within the product_images folder to accompany the blog post.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
BlogIds [KEY]	String	False		No	Id of the blogpost
Tag [KEY]	String	False		No	Tag which belongs to the blog.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	The id of the brand.
Name	String	False	No	The name of the brand. Must be unique.
PageTitle	String	False	No	The title shown in the browser while viewing the brand.
MetaKeywords	String	False	No	Comma-separated list of meta keywords to include in the HTML.
MetaDescription	String	False	No	A meta description to include.
ImageFile	String	False	No	A valid image.
SearchKeywords	String	False	No	A comma-separated list of keywords that can be used to locate this brand.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	The Id of this product category.
ParentId	Integer	False	Categories.Id	No	The Id of the category.
Name	String	False		No	Name of the this category.
Description	String	False		No	System name of the type of order status.
Views	Integer	False		No	Number of views the category has on the storefront.
SortOrder	Integer	False		No	Priority this category will be given when included in the menu and category pages.
PageTitle	String	False		No	Custom title for the category page.
MetaKeywords	String	False		No	Custom meta keywords for the category page.
MetaDescription	String	False		No	Custom meta description for the category page.
LayoutFile	String	False		No	A valid layout file.
ImageUrl	String	False		No	Image URL used for this category on the storefront.
IsVisible	Boolean	False		No	Flag to determine whether the product should be displayed to customers browsing the store.
SearchKeywords	String	False		No	A comma-separated list of keywords that can be used to locate the category when searching the store.
DefaultProductSort	String	False		No	Determines how the products are sorted on category page load.
UrlPath	String	False		No	URL Path.
IsCustomized	Boolean	False		No	Flag to determine whether the url is customized.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Listingid [KEY]	Long	True		No	The ID of the channel listing that has been created, returned, or updated
ChannelId [KEY]	Integer	True	Channels.Id	No	The ID of the channel associated with this channel listing
Datecreated	Datetime	True		No	Date on which the channel listing was first created
Datemodified	Datetime	True		No	Date on which the channel listing was most recently changed
Name	String	False		No	Name of the product for this channel listing specifically This is an optional field that can be used to override the product name in the catalog
Description	String	True		No	Description of the product for this channel listing specifically This is an optional field that can be used to override the product description in the catalog
Productid	Integer	False		No	The ID of the product associated with this channel listing
State	String	False		No	The state of the product assignment or channel listing
Variants	String	False		No	Product variant associated with the channel listing.
ExternalId	Integer	False		Yes

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	The ID of the channel.
ConfigMetaAppId	Integer	False	No	The unique id given to an app registered in DevTools
sections	String	False	No	If set, when the app is loaded within the control panel, the navigation sections will be directly embedded in the control panel navigation
Datecreated	Datetime	True	No	Date on which the channel was first create
Datemodified	Datetime	True	No	Date on which the channel was most recently changed
Externalid	String	False	No	Associated ID within a system / platform outside of BC
Iconurl	String	False	No	Link to the platform icon
Isenabled	Boolean	False	No	Channel with status of prelaunch, active, or connected will have is_enabled set to true. Channel with status of inactive, disconnected, archived, deleted, or terminated will have is_enabled set to false
IslistableFromUi	Boolean	False	No	Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create
Isvisible	Boolean	False	No	Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create
Name	String	False	No	Name of the channel as it will appear to merchants in the control panel
Platform	String	False	No	The name of the platform for the channel channel platform and type must be a valid combination
Status	String	False	No	The status of the channel channel type, platform, and status must be a valid combination. terminated is not valid for Update or Insert requests
Type	String	False	No	The type of channel channel platform and type must be a valid combinations

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	The coupons ID.
Name	String	False	No	The name of the coupon.
Type	String	False	No	Type of the coupon. Must be one of per_item_discount,per_total_discount,shipping_discount,free_shipping or percentage_discount.
Amount	Decimal	False	No	The discount to apply to an order, as either an amount or a percentage.
MinPurchase	Decimal	False	No	Specifies a minimum value that an order must have before the coupon can be applied to it.
Expires	Datetime	False	No	Specifies when a coupon expires.
Enabled	Boolean	False	No	If the coupon is enabled, this fields value is true; otherwise, false.
Code	String	False	No	The coupon code that customers uses to receive their discounts.
AppliesToEntity	String	False	No	What the discount applies to. Can be products or categories.
AppliesToIds	String	False	No	IDs of either the products or categories
NumUses	Integer	True	No	Number of times this coupon has been used.
MaxUses	Integer	False	No	Maximum number of times this coupon can be used.
MaxUsesPerCustomer	Integer	False	No	Maximum number of times each customer can use this coupon.
DateCreated	Datetime	False	No	Date Created
ShippingMethods	String	False	No	List of shipping-method names.
RestrictedToCountries	String	False	No	Countries where the coupon is restricted.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	Id of the currency.
IsDefault	Boolean	True	No	Specifies whether this is the store's default currency.
Code	String	False	No	Three-letter ISO 4217 code for this currency.
Name	String	False	No	Name of this currency.
ExchangeRate	Double	False	No	Amount of this currency that is equivalent to one U.S. dollar.
CountryIso	String	False	No	Two-letter ISO Alpha-2 code.
AutoUpdate	Boolean	False	No	Whether to autoupdate currency data.
TokenLocation	String	False	No	Symbol for this currency.
Token	String	False	No	Name of the currency.
DecimalToken	String	False	No	Symbol used as the decimal separator in this currency.
ThousandsToken	String	False	No	Symbol used as the thousands separator in this currency.
DecimalPlaces	Integer	False	No	Number of decimal places to show for this currency.
Enabled	Boolean	False	No	Indicates If the currency is active on the store.
IsTransactional	Boolean	False	No	Indicates if the currency is set as transactional or not. False means display only currency.
LastUpdated	Date	True	No	Date the currency was last updated, created or modified.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	ID of this customer address.
CustomerId	Integer	False	No	ID of the associated customer.
FirstName	String	False	No	The customers first name.
LastName	String	False	No	The customers last name.
Company	String	False	No	The customers company name.
Address1	String	False	No	The customers street address, line 1.
Address2	String	False	No	The customers street address, line 2.
City	String	False	No	The customers city/town/suburb.
StateOrProvince	String	False	No	The customers state/province.
PostalCode	String	False	No	The customers ZIP or postal code.
Country	String	False	No	The customers country. Must be the full country name.
CountryCode	String	False	No	2-letter ISO Alpha-2 code for the customers country.
Phone	String	False	No	The customers phone number.
AddressType	String	False	No	The type of the address.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Id of the customer group
Name	String	False	No	Name of the group
IsDefault	Boolean	False	No	Determines whether new customers are assigned to this group by default.
CategoryAccessType	String	False	No	Type of the category access.
CategoryAccessCategories	String	False	No	An array of category IDs.
IsGroupForGuests	Boolean	False	No	Describes whether the group is for guests. There can only be one customer group for guests at a time.
DateCreated	Date	False	No	Date on which the customer group was created.
DateModified	Date	False	No	Date on which the customer group was last modified.
DiscountRulesAmount	String	False	No	A collection of discount rules that are automatically applied to customers who are members of the group.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	Unique numeric ID of this customer.
Company	String	False	No	The name of the company for which the customer works.
FirstName	String	False	No	First name of the customer.
LastName	String	False	No	Last name of the customer.
Email	String	False	No	Email address of the customer.
Phone	String	False	No	Phone number of the customer.
DateCreated	Datetime	True	No	Date on which the customer registered from the storefront or was created in the control panel.
DateModified	Datetime	True	No	The date on which the customer was modified.
CustomerGroup	Integer	False	No	The group to which the customer belongs.
Notes	String	False	No	Store Owner notes on the customer.
TaxExemptCategory	String	False	No	Used to identify customers who fall into special sales-tax categories.
StoreCreditAmounts	String	False	No	Amount of Store Credit
RegistrationIpAddress	String	False	No	The IP address from which this customer was registered.
AcceptsProductReviewAbandonedCartEmails	Boolean	False	No	Whether the customer is signed up to receive product review emails, abandoned cart emails, or both. True if the customer is signed up for any of these.
ForcePasswordReset	Boolean	True	No	If true, this customer will be forced to change their password on their next login.
ChannelIds	String	False	No	Array of channel ids the Customer has access to.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	Integer	True	Orders.Id	No	Identifier for the BigCommerce Order with which this transaction is associated.
RecipientEmail	String	True		No	The recipient email of the digital consignment.
DownloadLineItemResources	String	True		No	URL where you can use a GET request to get the downloads line items for the order consignment.
DownloadLineItemUrl	String	True		No	Path where you can use a GET request to get the downloads line items for the order consignment.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	Integer	True	Orders.Id	No	Identifier for the BigCommerce Order with which this transaction is associated.
RecipientEmail	String	True		No	The recipient email of the gift certificate.
GiftCertificatesLineItemResources	String	True		No	URL where you can use a GET request to get the gift certificate line items for the order consignment.
GiftCertificatesLineItemUrl	String	True		No	Path where you can use a GET request to get the gift certificate line items for the order consignment.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	The ID of the gift certificate.
Code	String	False	No	A unique string that the customer can input to redeem the gift certificate.
Amount	Decimal	False	No	Value of the gift certificate.
Status	String	False	No	Status of the gift certificate.
Balance	Decimal	False	No	Remaining value of the gift certificate.
ToName	String	False	No	Name of the recipient.
ToEmail	String	False	No	Email of the recipient.
OrderId	Integer	False	No	The ID of the order.
Template	String	False	No	The email theme to use in the message sent to the recipient.
Message	String	False	No	Text that will be sent to the recipient, such as Congratulations.
FromName	String	False	No	Name of the customer who purchased the gift certificate.
FromEmail	String	False	No	Email of the customer who purchased the gift certificate.
CustomerId	Integer	False	No	The id of the customer placing the order.
ExpiryDate	Datetime	False	No	Date on which the gift certificate is set to expire.
PurchaseDate	Datetime	False	No	Date the gift certificate was purchased.
CurrencyCode	String	False	No	The currency code.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Numeric ID of this product within this order.
OrderId	Integer	False	No	Numeric ID of the associated order.
CouponId	Integer	False	No	The coupon id.
Code	String	False	No	The code of the coupon.
Amount	Decimal	False	No	The amount of the coupon.
Type	Integer	False	No	The type of the coupon.
Discount	Decimal	False	No	The discount of the coupon.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	The numerical ID of the option value within the group of ordered items.
OptionId	Integer	True	ProductOptions.Id	No	The ID of the option from Product Options table.
OrderItemId [KEY]	Integer	True	OrderItems.Id	No	The ID of the product.
OrderItemOptionId	Integer	False		No	The numerical ID of the option within the group of ordered items.
DisplayName	String	True		No	The name of the option shown on the storefront.
DisplayValue	String	True		No	The value of the option shown on the storefront.
Value	String	False		No	The actual value of the option.
Name	String	True		No	The unique option name, auto-generated from the display name, a timestamp, and the product ID.
Type	String	True		No	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.
DisplayStyle	String	True		No	The specific style which the order will be displayed as.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Numeric ID of this product within this order.
ProductId	Integer	False	Products.Id	No	Numeric ID of the product.
CustomSKU	String	False		No	User defined product code/stock keeping unit (SKU).
OrderId	Integer	False	Orders.Id	No	Numeric ID of the associated order.
Name	String	False		No	The product name.
PriceExTax	Decimal	False		No	The price of the product, excluding tax.
PriceIncTax	Decimal	False		No	The price of the product, including tax.
QuantityOrdered	Integer	False		No	Quantity of the product ordered.
QuantityShipped	Integer	True		No	Quantity of the product shipped.
TotalExtax	Decimal	True		No	Total base price, excluding tax.
TotalIncTax	Decimal	True		No	Total base price, including tax.
IsRefunded	Boolean	True		No	Whether the product has been refunded.
ExternalId	Integer	False		No	ID of the order in another system.
AppliedDiscounts	String	True		No	Array of objects containing discounts applied to the product.
BaseCostPrice	Decimal	False		No	The product's cost price.
BasePrice	Decimal	False		No	The product�s base price.
BaseTotal	Decimal	False		No	Total base price.
BaseWrappingCost	Decimal	False		No	The value of the base wrapping cost.
BinPickingNumber	Integer	False		No	Bin picking number for the physical product.
Brand	String	False		No	The product's brand.
ConfigurableFields	String	False		No	The price of the product, excluding tax.
CostPriceExTax	Decimal	False		No	The product's cost price excluding tax.
CostPriceIncTax	Decimal	False		No	The product's cost price including tax.
CostPriceTax	Decimal	False		No	Tax applied to the product�s cost price.
Depth	Decimal	False		No	Depth of the product.
DiscountedTotalIncTax	Decimal	False		No	Represent the correct total amount of the line item after deducting all the discounts and including the tax.
EbayItemId	String	False		No	Item ID for this product on eBay.
EbayTransactionId	String	False		No	Transaction ID for this product on eBay.
EventDate	String	False		No	Date of the promotional event/scheduled delivery.
EventName	String	False		No	Name of promotional event/delivery date.
FixedShippingCost	Decimal	False		No	Fixed shipping cost for this product.
FulfillmentSource	String	False		No	The source of the fulfillment.
GiftCertificateId	String	False		No	ID of the associated gift certificate.
Height	Decimal	False		No	Height of the product
IsBundledProduct	Boolean	False		No	Whether this product is bundled with other products.
NameCustomer	String	False		No	The product name that is shown to customer in storefront.
NameMerchant	String	False		No	The product name that is shown to merchant in Control Panel.
OptionSetId	Integer	False		No	Numeric ID of the option set applied to the product.
OrderAddressId	Integer	False		No	Numeric ID of the associated order address. Value is 0 for items that are not fulfilled by a pickup method.
OrderPickupMethodId	Integer	False		No	ID of the pickup fulfillment method for this item. Default value is 0 when the item is not fulfilled by pickup method.
ParentOrderProductId	Integer	False		No	ID of a parent product.
PriceTax	Decimal	False		No	Amount of tax applied to a single product.
RefundAmount	Decimal	False		No	The amount to be refunded.
ReturnId	Integer	False		No	Numeric ID for the refund.
TotalTax	Decimal	False		No	Total tax applied to products.
Type	String	False		No	Type of product.
Upc	String	False		No	Universal Product Code. Can be written to for custom products and catalog products.
VariantId	Integer	False		No	Products variant_id.
Weight	Decimal	False		No	Weight of the product.
Width	Decimal	False		No	Width of the product.
WrappingCostExTax	Decimal	False		No	The value of the wrapping cost, excluding tax.
WrappingCostIncTax	Decimal	False		No	The value of the wrapping cost, including tax.
WrappingCostTax	Decimal	False		No	Tax applied to gift-wrapping option.
WrappingId	Integer	False		No	The price of the product, excluding tax.
WrappingMessage	String	False		No	Message to accompany gift-wrapping option.
WrappingName	String	False		No	Name of gift-wrapping option.
LinkedOrderOptions	String	False		Yes	Column for the aggregate table name holding option values.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Numeric ID of this product within this order.
OrderId	Integer	False	No	Numeric ID of the associated order.
StaffId	Integer	False	No	The staff id.
CustomerId	Integer	False	No	The customer id.
Type	String	False	No	Type of the message.
Subject	String	False	No	Subject of the message.
Message	String	False	No	Message content.
Status	String	False	No	Status of the message.
IsFlagged	Boolean	False	No	Indicator if the message is flagged.
DateCreated	Datetime	False	No	Datetime when the message was first created.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	Refund resource ID.
Created [KEY]	Datetime	True	No	Timestamp of when this refund was created.
OrderId	Integer	True	No	Reference to order id.
Reason	String	True	No	Reason for refund.
TotalAmount	Decimal	True	No	A non-negative 2 decimal place rounded value that represents the amount that can be charged/refunded via payment providers.
TotalTax	Decimal	True	No	Total tax amount refunded back to the shopper. Note: order_level_amount does not affect tax liability.
UserId	Integer	True	No	Reference to the user's id who create this refund.
UsesMerchantOverrideValues	Boolean	True	No	Whether refund amount and tax are provided explicitly by merchant override

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
ItemId [KEY]	Integer	False		No	order_product.id corresponding to the item_types of PRODUCT, GIFT_WRAPPING. order_address.id corresponding to the item_types of SHIPPING, HANDLING. order.id corresponding to the item_type of ORDER.
OrderRefundId [KEY]	Integer	True	OrderRefunds.Id	No	The ID of the order refund.
OrderId	Integer	True	OrderRefunds.OrderId	No	Reference to order id.
ItemType	String	False		No	Type of item that was refunded.
Quantity	Integer	False		No	Quantity of item refunded. Note: this will only be populated for item_type PRODUCT
Reason	String	False		No	Reason for refunding an item.
RequestedAmount	Decimal	False		No	A non-negative 2 decimal place rounded value that represents the amount that can be charged/refunded via payment providers..

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False		No	The ID of the refund payment.
OrderRefundId	Integer	True	OrderRefunds.Id	No	The ID of the order refund.
OrderId	Integer	True	OrderRefunds.OrderId	No	Reference to order id.
ProviderId	String	False		No	Reference to payment provider.
Amount	Decimal	False		No	A non-negative 2 decimal place rounded value that represents the amount that can be charged/refunded via payment providers.
Offline	Boolean	False		No	Indicate whether payment was offline.
IsDeclined	Boolean	False		No	Indicate if this payment has been declined by payment provider.
DeclinedMessage	String	False		No	Message indicate why payment was declined.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	The Id of the order.
CustomerId	String	False	Customers.Id	No	The Id of the customer assigned to this order.
DateCreated	Datetime	True		No	The date of creation for the order.
DateModified	Datetime	True		No	The last modification date of the order.
DateShipped	Datetime	True		No	The date of shipment for the order.
StatusId	String	False	OrderStatuses.Id	No	The Id of the status for this order.
CartId	String	True		No	The Id of the cart from which this order is assigned.
Status	String	True		No	Order Statuses.
TotalTax	String	True		No	The total value of the order.
SubtotalTax	String	True		No	The value for subtotal tax.
SubtotalExTax	Decimal	False		No	The value for subtotal, excluding tax.
SubtotalIncTax	Decimal	False		No	The value for subtotal, including tax.
ShippingCostExTax	Decimal	False		No	The value of shipping cost, excluding tax.
ShippingCostIncTax	Decimal	False		No	The value of shipping cost, including tax.
HandlingCostExTax	Decimal	False		No	The value of handling cost, excluding tax.
HandlingCostIncTax	Decimal	False		No	The value of handling cost, including tax.
IpAddress	String	False		No	IPv4 Address of the customer, if known.
WrappingCostExTax	Decimal	False		No	The value of wrapping cost, excluding tax.
WrappingCostIncTax	Decimal	False		No	The value of wrapping cost, including tax.
TotalExTax	Decimal	False		No	The total value of the order, excluding tax.
TotalIncTax	Decimal	False		No	The total value of the order, including tax.
HandlingCostTax	String	True		No	The value of handling cost.
HandlingCostTaxClassId	Integer	True		No	The Id of handling cost.
ShippingCostTax	String	True		No	The value of shipping cost.
ItemsTotal	Integer	False		No	The total number of items in the order.
ItemsShipped	Integer	False		No	The total number of items that have been shipped.
PaymentMethod	String	False		No	The payment method for this order.
PaymentProviderId	String	False		No	The external Transaction ID/Payment ID within this order's payment provider (if a payment provider was used).
PaymentStatus	String	True		No	The payment status for this order.
RefundedAmount	Decimal	False		No	The amount refunded from this transaction.
GiftCertificateAmount	String	True		No	Gift Certificate Amount.
CurrencyId	String	True	Currencies. Id	No	The ID of the currency being used in this transaction.
CurrencyCode	String	True		No	The currency code of the display currency.
CurrencyExchangeRate	String	True		No	The exchange rate between the default currency and display currency of store.
DefaultCurrencyId	String	True	Currencies.Id	No	The ID of the default currency for the store.
DefaultCurrencyCode	String	False		No	The currency code of the transactional currency the shopper pays in.
StaffNotes	String	False		No	Any additional notes for staff.
CustomerMessage	String	False		No	Message that the customer entered.
DiscountAmt	Decimal	False		No	Amount of discount for this transaction.
EbayOrderId	String	False		No	Ebay order number if order is placed through Ebay.
GeoIpCountryIso2	String	False		No	The country where the customer made the purchase, in ISO2 format.
ShippingAddressCount	Integer	True		No	The number of shipping addresses associated with this transaction.
CouponDiscount	String	True		No	Discount of the coupon.
OrderSource	String	True		No	Source of the order.
IsDeleted	Boolean	True		No	Indicates whether the order was deleted (archived).
OrderIsDigital	Boolean	False		No	Indicates whether this is an order for digital products.
ExternalSource	String	False		No	A value identifying the system used to generate the order (for orders submitted or modified via the API).
ExternalId	String	False		No	ID of the order in another system.
ExternalMerchantId	String	False		No	Id of the external merchant.
ChannelId	String	False		No	Shows where the order originated.
TaxProviderId	String	False		No	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; (blank) - When the tax provider is unknown.
ProductsUrl	String	False		No	Url of the products.
ProductsResource	String	False		No	Resource of the products.
BillingFirstName	String	False		No	Addressee first name.
BillingLastName	String	False		No	Addressee last name.
BillingCompany	String	False		No	Addressee company.
BillingStreet1	String	False		No	Street address (first line).
BillingStreet2	String	False		No	Street address (second line).
BillingCity	String	False		No	Addressee city
BillingZip	String	False		No	ZIP or postal code
BillingCountry	String	False		No	Addressee's country
BillingCountryIso2	String	False		No	Addressee's country code
BillingState	String	False		No	The name of the state or province. Should be spelled out in full, for example, California.
BillingEmail	String	False		No	Recipient's email address.
BillingPhone	String	False		No	Recipient's telephone number.
BaseHandlingCost	String	False		No	The value of the base handling cost.
BaseShippingCost	String	False		No	The value of the base shipping cost.
BaseWrappingCost	String	False		No	The value of the base wrapping cost.
LinkedProducts	String	False		Yes	Column for the aggregate table name holding order products.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Numeric ID of this shipment within this order.
OrderId [KEY]	Integer	False	Orders.Id	No	Numeric ID of the associated order.
DateCreated	Datetime	True		No	Creation date for the shipment.
TrackingNumber	String	False		No	Tracking number of the shipment.
TrackingCarrier	String	False		No	Tracking carrier for the shipment.
TrackingLink	String	True		No	Returns a tracking link from the shipping service.
ShippingProvider	String	False		No	Enum of the BigCommerce shipping-carrier integration/module.
ShippingMethod	String	False		No	Enum of the BigCommerce shipping-carrier integration/module.
Comments	String	False		No	Comments the shipper wishes to add.
OrderAddressId	Integer	False	OrderShippingAddresses.Id	No	ID of this shipping address.
CustomerId	String	False		No	ID of this order’s customer.
ShippingProviderDisplayName	String	True		No	The human-readable name for the shipping_provider.
MerchantShippingCost	Decimal	True		No	The shipping merchant cost.
BillingAddressCity	String	True		No	The billing address city.
BillingAddressCompany	String	True		No	The billing address company.
BillingAddressCountry	String	True		No	The billing address country
BillingAddressCountryIso2	String	True		No	The billing address country iso2.
BillingAddressEmail	String	True		No	The email of the Addressee.
BillingAddressFirstName	String	True		No	Addressee's First Name.
BillingAddressLastName	String	True		No	Addressee's Last Name.
BillingAddressPhone	String	True		No	Addressee's Phone.
BillingAddressState	String	True		No	Addressee's State.
BillingAddressStreet1	String	True		No	Street address (first line).
BillingAddressStreet2	String	True		No	Street address (second line).
BillingAddressZip	String	True		No	ZIP or postal code.
LinkedProducts	String	False		Yes	Column for the aggregate table name holding order products.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	ID of this shipping address.
OrderId	Integer	True	No	ID of the order.
FirstName	String	True	No	Addressee first name.
LastName	String	True	No	Addressee last name.
Company	String	True	No	Addressee company.
Street1	String	True	No	Street address (first line).
Street2	String	True	No	Street address (second line).
City	String	True	No	Addressee city.
Zip	String	True	No	ZIP or postal code.
Country	String	True	No	Addressee's country.
State	String	True	No	The name of the state or province. Should be spelled out in full, for example, California.
Email	String	True	No	Recipient's email address.
Phone	String	True	No	Recipient's telephone number.
BaseCost	Decimal	True	No	The base value of the order's items.
BaseHandlingCost	Decimal	True	No	The base handling charge.
CostExTax	Decimal	True	No	The value of the order's items, excluding tax.
CostIncTax	Decimal	True	No	The value of the order's items, including tax.
CostTax	Decimal	True	No	The tax amount on the order.
CostTaxClassId	String	True	No	The ID of the tax class applied to the product.
CountryIso2	String	True	No	2-letter ISO Alpha-2 code for the country.
HandlingCostExTax	Decimal	True	No	The handling charge, excluding tax.
HandlingCostIncTax	Decimal	True	No	The handling charge, including tax.
HandlingCostTax	Decimal	True	No	The handling charge.
HandlingCostTaxClassId	String	True	No	A read-only value. Do not attempt to set or modify this value in a POST or PUT operation.
ItemsShipped	Integer	True	No	The number of items that have been shipped.
ItemsTotal	Integer	True	No	The total number of items in the order.
ShippingMethod	String	True	No	Text code identifying the BigCommerce shipping module selected by the customer.
ShippingZoneId	Integer	True	No	Numeric ID of the shipping zone.
ShippingZoneName	String	True	No	Name of the shipping zone.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	The Id of the type of order status
Name	String	True	No	Name of the type of order status.
Systemlabel	String	True	No	System name of the type of order status.
CustomLabel	String	True	No	Custom order status label given in the Control Panel.
SystemDescription	String	True	No	System description of the order status.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Numeric ID of this product within this order.
OrderId	Integer	False	No	Numeric ID of the associated order.
OrderAddressId	Integer	False	No	The unique numeric identifier of the order address object associated with the order.
TaxRateId	Integer	False	No	The unique numeric identifier of the tax rate.
TaxClassId	Integer	False	No	The unique numeric identifier of the tax class object.
Name	String	False	No	The name of the tax class object.
Class	String	False	No	The name of the type of tax that was applied.
Rate	Decimal	False	No	The tax rate.
Priority	Integer	False	No	The order in which the tax is applied.
PriorityAmount	Decimal	False	No	The amount of tax calculated on the order.
LineAmount	Decimal	False	No	The line amount.
OrderProductId	String	False	No	If the line_item_type is item or handling then this field will be the order product id. Otherwise the field will return as null.
LineItemType	String	False	No	Type of tax on item.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False		No	Id of the page.
ChannelId	Integer	False	Channels.Id	No	Channel Id of the page.
Name	String	False		No	Name of the page.
Email	String	False		No	Email of the page.
MetaTitle	String	False		No	Title of the page.
Body	String	False		No	Body of the page.
IsVisible	Boolean	False		No	Indicator if page is visible.
ParentId	Integer	False		No	Parent id of the page.
SortOrder	Integer	False		No	Sort order of the page.
MetaKeywords	String	False		No	Keywords of the page.
Type	String	False		No	Type of the page.
MetaDescription	String	False		No	Description of the page.
IsHomepage	Boolean	False		No	Indicator if the page is homepage.
IsCustomersOnly	Boolean	False		No	Indicator if the page is customer only.
SearchKeywords	String	False		No	Search keywords of the page.
Url	String	False		No	Url of the page.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Code [KEY]	String	False	No	The code of the payment method.
Name	String	False	No	The name of the payment method.
TestMode	Boolean	False	No	Indicator if the payment method is in test mode.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id	Integer	True		No	The ID of the pickup consignment to update.
OrderId	Integer	True	Orders.Id	No	Identifier for the BigCommerce Order with which this transaction is associated.
PickupMethodId	Integer	True		No	The ID of the pickup consignment to update.
PickupMethodDisplayName	String	True		No	A name for the pickup method that can be displayed to shoppers.
CollectionInstructions	String	True		No	A message for shoppers explaining how to collect their pickup order.
CollectionTimeDescription	String	True		No	A message for shoppers indicating the estimated time their pickup order will be ready for collection.
LocationId	Integer	True		No	ID of the location.
LocationName	String	True		No	The name of the pickup location.
LocationCode	String	True		No	The code of the pickup location.
LocationAddressLine1	String	True		No	Pickup location's Street address (first line)
LocationAddressLine2	String	True		No	Pickup location's Street address (second line).
LocationCity	String	True		No	Pickup location's city.
LocationState	String	True		No	Pickup location's state.
LocationPostalCode	String	True		No	Pickup location's postal code.
LocationCountryAlpha2	String	True		No	2-letter ISO Alpha-2 code for the country.
LocationEmail	String	True		No	Pickup location's email address
LocationPhone	String	True		No	Pickup location's phone number.
PickupsLineItemResources	String	True		No	URL where you can use a GET request to get the pickups line items for the order consignment.
PickupsLineItemUrl	String	True		No	Path where you can use a GET request to get the pickups line items for the order consignment.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id	Integer	True	No	The ID of the PriceList Assignment.
CustomerGroupId	Integer	True	No	The ID of the customer group.
PriceListId	Integer	True	No	The ID of the PriceList.
ChannelId	Integer	True	No	ID of the Channel.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
CalculatedPrice	Double	True	No	The price of the variant as seen on the storefront if a price record is in effect
DateCreated	Datetime	True	No	The date of creation for the Price Entry.
DateModified	Datetime	True	No	The last modification date of the Price Entry.
ProductId	Integer	True	No	The id of the Product this Price Record's variant_id is associated with.
PriceListId [KEY]	Integer	True	No	The Price List ID with which this price set is associated
VariantId [KEY]	Integer	False	No	The variant with which this price set is associated.
Sku	String	False	No	The variant with which this price set is associated
Currency [KEY]	String	False	No	The 3-letter currency code with which this price set is associated
Price	Double	False	No	The list price for the variant mapped in a Price List
SalePrice	Double	False	No	The sale price for the variant mapped in a Price List
RetailPrice	Double	False	No	The retail price for the variant mapped in a Price List
MapPrice	Double	False	No	The MAP (Manufacturers Advertised Price) for the variant mapped in a Price List
BulkPricingTiers	Integer	False	No	The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing
QuantityMin	Integer	False	No	The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing
QuantityMax	Integer	False	No	The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.
QuantityType	String	False	No	The type of adjustment that is made.
QuantityAmount	Double	False	No	The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	ID of the PriceList.
Active	Boolean	False	No	The status of the PriceList.
DateCreated	Datetime	True	No	The date of creation for the PriceList.
DateModified	Datetime	True	No	The last modification date of the PriceList.
Name	String	False	No	The name of the PriceList.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	The ID of the bulk discount rule.
ProductId [KEY]	Integer	False	No	The ID of the product associated with this bulk discount rule.
Min	Integer	False	No	The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero.
Max	Integer	False	No	The maximum inclusive quantity of a product to satisfy this rule.
Type	String	False	No	Type of the discount.
TypeValue	Decimal	False	No	The value of the discount

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Numeric ID of the custom field.
ProductId	Integer	False	No	Id of the product that the custom field belongs to.
Name	String	False	No	Name of the custom field.
Text	String	False	No	Value of the custom field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False		No	The Id of the image.
ProductId [KEY]	Integer	False	Products.Id	No	The Id of the corresponding product.
ImageFile	String	False		No	The local path to the original image file uploaded to BigCommerce.
StandardUrl	String	False		No	Standard Image URL for the product.
ThumbnailUrl	String	False		No	The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels.
IsThumbnail	Boolean	False		No	Flag for identifying whether the image is used as the product's thumbnail.
SortOrder	Integer	False		No	The order in which the image will be displayed on the product page.
Description	String	False		No	The description for the image.
DateModified	Datetime	True		No	The last modification date of the image.
TinyUrl	String	False		No	Tiny URL for the product.
ZoomUrl	String	False		No	Zoom URL for the product.
ImageUrl	String	False		Yes	The local path to the original image file to be uploaded to BigCommerce.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Unique ID of the Metafield.
ProductId [KEY]	Integer	True	Products.Id	No	The Id of the corresponding product.
DateCreated	Datetime	True		No	Date and time of the metafield?s creation.
DateModified	Datetime	True		No	Date and time when the metafield was last updated.
Description	String	False		No	Description for the metafields.
Key	String	False		No	The name of the field.
Value	String	False		No	The value of the field,must enter a JSON formatted string for ShipperHQ metafields.
Namespace	String	False		No	Namespace for the metafield, for organizational purposes.
OwnerClientId	String	True		No	ID of metafield's creator.
PermissionSet	String	False		No	Determines the visibility and writeability of the field by other API consumers.Must be one of app_only, read, write, read_and_sf_access or write_and_sf_access.
ResourceId	Integer	True		No	The ID of the resource with which the metafield is associated.
ResourceType	String	True		No	The type of resource with which the metafield is associated.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	The ID of the option.
ProductId [KEY]	Integer	True	Products.Id	No	The ID of the product.
DisplayName	String	False		No	The name of the option shown on the storefront.
Name	String	False		No	The unique option name, auto-generated from the display name, a timestamp, and the product ID.
Type	String	False		No	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.
SortOrder	Integer	False		No	The order in which the option will be displayed on the product page.
ConfigDefaultValue	String	False		No	The default value. Shown on a date option as an ISO-8601�formatted string, or on a text option as a string.
ConfigCheckedByDefault	Boolean	False		No	Flag for setting the checkbox to be checked by default.
ConfigCheckboxLabel	String	False		No	Label displayed for the checkbox option.
ConfigDateLimited	Boolean	False		No	Flag to limit the dates allowed to be entered on a date option.
ConfigDateLimitMode	String	False		No	The type of limit that is allowed to be entered on a date option.
ConfigDateEarliestValue	String	False		No	The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.
ConfigDateLatestValue	String	False		No	The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.
ConfigFileTypesMode	String	False		No	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.
ConfigFileTypesSupported	String	False		No	The type of files allowed to be uploaded if the file_type_option is set to specific.
ConfigFileTypesOther	String	False		No	A list of other file types allowed with the file upload option.
ConfigFileMaxSize	Integer	False		No	The maximum size for a file that can be used with the file upload option. This will still be limited by the server.
ConfigTextCharactersLimited	Boolean	False		No	Flag to validate the length of a text or multi-line text input.
ConfigTextMinLength	Integer	False		No	The minimum length allowed for a text or multi-line text option.
ConfigTextMaxLength	Integer	False		No	The maximum length allowed for a text or multi line text option.
ConfigTextLinesLimited	Boolean	False		No	Flag to validate the maximum number of lines allowed on a multi-line text input.
ConfigTextMaxLines	Integer	False		No	The maximum number of lines allowed on a multi-line text input.
ConfigNumberLimited	Boolean	False		No	Flag to limit the value of a number option.
ConfigNumberLimitMode	String	False		No	The type of limit on values entered for a number option.
ConfigNumberLowestValue	Integer	False		No	The lowest allowed value for a number option if number_limited is true.
ConfigNumberHighestValue	Integer	False		No	The highest allowed value for a number option if number_limited is true.
ConfigNumberIntegersOnly	Boolean	False		No	Flag to limit the input on a number option to whole numbers only.
ConfigProductListAdjustsInventory	Boolean	False		No	Flag for automatically adjusting inventory on a product included in the list.
ConfigProductListAdjustsPricing	Boolean	False		No	Flag to add the optional product's price to the main product's price.
ConfigProductListShippingCalc	String	False		No	How to factor the optional product's weight and package dimensions into the shipping quote.
LinkedOptionValues	String	False		Yes	Column for the aggregate table name holding option values.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	The ID of the option value.
OptionId [KEY]	Integer	True	ProductOptions.Id	No	The ID of the option.
ProductId [KEY]	Integer	True	Products.Id	No	The ID of the product.
Label	String	False		No	The label of the option value shown on the storefront.
IsDefault	Boolean	False		No	Whether this option value is the default for this option.
SortOrder	Integer	False		No	The order in which the option value will be displayed on the product page.
ValueDataColors	String	False		No	The colors contained in the value data.
ValueDataImgUrl	String	False		No	The image url contained in the value data.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False		No	The Id of the review.
ProductId [KEY]	Integer	True	Products.Id	No	The Id of the corresponding product.
Title	String	False		No	Title of the review.
Text	String	False		No	Text content of the review.
Status	String	False		No	The status of the product review. Must be one of approved, disapproved, or pending.
Rating	Integer	False		No	The rating of the product review. Must be one of 0, 1, 2, 3, 4, or 5.
Email	String	False		No	The email of the reviewer. Must be a valid email, or an empty string.
Name	String	False		No	The name of the reviewer.
DateCreated	Datetime	True		No	The date of creation for the review.
DateModified	Datetime	True		No	The last modification date of the review.
DateReviewed	Datetime	False		No	Date the product was reviewed.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	The ID of the rule.
ProductId [KEY]	Integer	False	No	The ID of the product to which the rule belongs.
SortOrder	Integer	False	No	The order in which the rule will be displayed on the product page.
IsEnabled	Boolean	False	No	If set to true, the rule will be evaluated when a customer configures a products options.
IsStop	Boolean	False	No	If set to true and the rule evaluates to true, no more rules with a higher sort_order will be processed.
PriceAdjusterName	String	False	No	Price adjuster name.
PriceAdjusterValue	Decimal	False	No	Price adjuster value.
WeightAdjusterName	String	False	No	Weight adjuster name.
WeightAdjusterValue	Decimal	False	No	Weight adjuster value.
IsPurchasingDisabled	Boolean	False	No	If true this rule prohibits purchasing the product with the configured option values.
PurchasingDisabledMessage	String	False	No	The message to display if the rule disabled purchasing the product.
IsPurchasingHidden	Boolean	False	No	If true the rule hides the options on the product.
ImageFile	String	False	No	A path to an rule already uploaded via FTP in the import directory and the path should be relative from the import directory.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	The Id of the product.
Name	String	False	No	The product name.
Type	String	False	No	The product type.
Sku	String	True	No	User-defined product code/stock keeping unit (SKU)
Description	String	False	No	Product description, which can include HTML formatting.
SearchKeywords	String	False	No	A comma-separated list of keywords that can be used to locate the product when searching the store.
AvailabilityDescription	String	False	No	Availability text, displayed on the checkout page under the product title, telling the customer how long it will normally take to ship this product.
Price	Decimal	False	No	The products price.
CostPrice	Decimal	False	No	The products cost price.
RetailPrice	Decimal	False	No	The products retail cost.
SalePrice	Decimal	False	No	Sale price.
MapPrice	Decimal	False	No	Map price.
ProductTaxCode	String	False	No	Tax Codes.
CalculatedPrice	Decimal	True	No	Price as displayed to guests, adjusted for applicable sales and rules.
SortOrder	Integer	False	No	Priority to give this product when included in product lists on category pages and in search results.
IsVisible	Boolean	False	No	Flag to determine whether or not the product should be displayed to customers browsing.
IsFeatured	Boolean	False	No	Flag to determine whether the product should be included in the featured products panel for shoppers viewing the store.
RelatedProducts	String	False	No	Defaults to -1, which causes the store to automatically generate a list of related products.
InventoryLevel	String	False	No	Current inventory level of the product.
InventoryWarningLevel	String	False	No	Inventory Warning level for the product.
Warranty	String	False	No	Warranty information displayed on the product page.
Weight	Decimal	False	No	Weight of the product, which can be used when calculating shipping costs.
Width	Decimal	False	No	Width of the product, which can be used when calculating shipping costs.
Height	Decimal	False	No	Height of the product, which can be used when calculating shipping costs.
Depth	Decimal	False	No	Depth of the product, which can be used when calculating shipping costs.
FixedCostShippingPrice	Decimal	False	No	A fixed shipping cost for the product.
IsFreeShipping	Boolean	False	No	Flag used to indicate whether or not the product has free shipping.
InventoryTracking	String	False	No	The type of inventory tracking for the product.
RatingTotal	Integer	False	No	The total rating for the product.
RatingCount	Integer	False	No	The total number of ratings the product has had.
ReviewsRatingSum	Integer	True	No	The total (cumulative) rating for the product.
ReviewsCount	Integer	True	No	The number of times the product has been rated.
TotalSold	Integer	False	No	Total quantity of this product sold through transactions.
DateCreated	Datetime	False	No	The date of which the product was created.
BrandId	Integer	True	No	The products brand
ViewCount	Integer	False	No	The number of times the product has been viewed.
PageTitle	String	False	No	Custom title for the products page.
MetaKeywords	String	False	No	Custom meta keywords for the product page.
MetaDescription	String	False	No	Custom meta description for the product page.
LayoutFile	String	False	No	The layout template file used to render this product category.
IsPriceHidden	Boolean	False	No	The default false value indicates that this products price should be shown on the product page.
PriceHiddenLabel	String	False	No	By default, an empty string. If is_price_hidden is true, the value of price_hidden_label will be displayed instead of the price.
Categories	Int[]	False	No	An array of IDs for the categories this product belongs to. When updating a product, if an array of categories is supplied, then all product categories will be overwritten.
DateModified	Datetime	False	No	The date that the product was last modified.
Condition	String	False	No	The products condition.
IsConditionShown	Boolean	False	No	Flag used to determine whether the products condition will be shown to the customer on the product page.
PreorderReleaseDate	Datetime	False	No	Pre-order release date.
IsPreorderOnly	Boolean	False	No	If set to false, the product will not change its availability from preorder to available on the release date.
PreorderMessage	String	False	No	Custom expected-date message to display on the product page.
OrderQuantityMinimum	Integer	False	No	The minimum quantity an order must contain in order to purchase this product.
OrderQuantityMaximum	Integer	False	No	The maximum quantity an order can contain when purchasing the product.
OpenGraphType	String	False	No	Type of product.
OpenGraphTitle	String	False	No	Title of the product. If not specified, the products name will be used instead.
OpenGraphDescription	String	False	No	Description to use for the product.
OpenGraphUseMetaDescription	Boolean	False	No	Flag to determine if product description or open graph description is used.
OpenGraphUseProductName	Boolean	False	No	Flag to determine if product name or open graph name is used.
OpenGraphUseImage	Boolean	False	No	Flag to determine if product image or open graph image is used.
IsOpenGraphThumbnail	Boolean	False	No	If set to true, the product thumbnail image will be used as the open graph image.
UPC	String	False	No	The product UPC code, which is used in feeds for shopping comparison sites.
GTIN	String	False	No	Global Trade Item Number.
OptionSetId	Integer	True	No	The ID of the option set applied to the product.
TaxClassId	Integer	True	No	The ID of the tax class applied to the product.
OptionSetDisplay	String	True	No	The position on the product page where options from the option set will be displayed.
BinPickingNumber	String	False	No	The BIN picking number for the product.
CustomUrl	String	False	No	Custom URL (if set) overriding the structure dictated in the stores settings.
CustomFields	String	False	No	200 maximum custom fields per product. 255 maximum characters per custom field.
ManufacturerPartNumber	String	False	No	Manufacturer Part Number.
IsCustomized	Boolean	False	No	Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides.
Url	String	False	No	Product URL on the storefront.
Availability	String	False	No	Availability of the product.
PrimaryImageId	Integer	True	No	Id of the primary image.
PrimaryImageProductId	Integer	True	No	ProductId of the primary image.
PrimaryImageIsThumbnail	Boolean	True	No	Primary image Is Thumbnail or not.
PrimaryImageSortOrder	String	True	No	Sort Order of the primary image.
PrimaryImageDescription	String	True	No	Description of the primary image.
PrimaryImageImageFile	String	True	No	Image file of the primary image.
PrimaryImageUrlZoom	String	True	No	Zoom Url of the primary image.
PrimaryImageStandardUrl	String	True	No	Standard url of the primary image.
PrimaryImageUrlThumbnail	String	True	No	Thumbnail url of the primary image.
PrimaryImageUrlTiny	String	True	No	Tiny url of the primary image.
PrimaryImageDateModified	Datetime	True	No	Modified Date of the primary image.
GiftWrappingOptionsType	String	True	No	Type of gift-wrapping options.
GiftWrappingOptionsList	String	True	No	Type of gift-wrapping option IDs.
BaseVariantId	String	True	No	Base Variant Id.
ProductVariants	String	False	Yes	Variants of the Products

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	ID of this sku.
ProductId [KEY]	Integer	False	No	ID of the associated product.
Sku	String	False	No	The unique SKU (stock keeping unit).
Price	Decimal	False	No	This SKUs base price on the storefront.
AdjustedPrice	Decimal	False	No	The SKUs price on the storefront, after the products base price is inherited, or any option set or any product rules are applied.
CostPrice	Decimal	False	No	The products cost price.
UPC	String	False	No
InventoryLevel	Integer	False	No	The inventory level for the product.
InventoryWarningLevel	Integer	False	No	The inventory warning level for the product .
BinPickingNumber	String	False	No	The BIN picking number.
Weight	Decimal	False	No	This SKUs base weight on the storefront.
AdjustedWeight	Decimal	False	No	This SKUs weight on the storefront, after the products base weight is inherited, or any option set or any product rules are applied.
IsPurchasingDisabled	Boolean	False	No	If true, this prohibits purchasing of the SKU.
PurchasingDisabledMessage	String	False	No	The message to display if purchasing is disabled on this SKU.
ImageFile	String	False	No	The image that will be displayed when this SKU is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	The ID of the product variant.
ProductId [KEY]	Integer	True	Products.Id	No	The ID of the product.
SKU	String	False		No	User defined product code/stock keeping unit (SKU).
SKU_ID	String	False		No	The ID for User defined product code/stock keeping unit (SKU).
Price	Decimal	False		No	The price of the product variant. The price should include or exclude tax, based on the store settings.
CalculatedPrice	Integer	False		No	The variant’s calculated price on the storefront.
SalePrice	Integer	False		No	The variant’s sale price on the storefront.
RetailPrice	Integer	False		No	The variant’s retail price on the storefront.
MapPrice	Integer	False		No	The Minimum Advertised Price.
Weight	String	False		No	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.
Calculated_Weight	Integer	False		No	The variant’s calculated weight on the storefront.
Width	Long	False		No	Width of the variant, which can be used when calculating shipping costs.
Height	Long	False		No	The Height of the variant, which can be used when calculating shipping costs.
Depth	Long	False		No	The Depth of the variant, which can be used when calculating shipping costs.
Is_Free_Shipping	Boolean	False		No	The Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
FixedCostShippingPrice	Integer	False		No	The fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
Purchasing_Disabled	String	False		No	Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories.
Purchasing_Disabled_Message	String	False		No	Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories.
Image_Url	String	False		No	The Image url for the variant.
CostPrice	Integer	False		No	The cost price of the variant.
Upc	String	False		No	The UPC code used in feeds for shopping comparison sites and external channel integrations.
Mpn	String	False		No	The Manufacturer Part Number (MPN) for the variant.
Gtin	String	False		No	The Global Trade Item Number.
InventoryLevel	Integer	False		No	The Inventory level for the variant, which is used when the product’s inventory_tracking is set to variant.
InventoryWarningLevel	Integer	False		No	The Inventory warning level for the product
BinPickingNumber	String	False		No	Identifies where in a warehouse the variant is located.
LinkedOptionValues	String	False		No	The Option Value Id.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False		No	The ID of the option value.
VariantId [KEY]	Integer	True	ProductVariants.Id	No	The ID of the corresponding variant.
OptionId [KEY]	Integer	False	ProductOptions.Id	No	The ID of the option.
Label	String	True		No	The label of the option value shown on the storefront.
DisplayName	String	True		No	The label of the option value shown on the storefront.
ProductId	String	True	Products.Id	No	The Id of the product

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	ID of this video.
ProductId [KEY]	Integer	False	No	ID of the associated product.
SortOrder	Integer	False	No	Sort order for this video.
Name	String	False	No	The title for the video.
Length	String	False	No	The duration of the video.
Description	String	False	No	The description for the video.
VideoId	String	False	No	The ID of the video on a host site.
Type	String	False	No	The video type (a short name of a host site)

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Numeric ID of the redirect.
SiteId	Integer	False	No	Site ID of the redirect.
FromPath	String	False	No	The path from which to redirect.
ToType	String	False	No	The type of redirect.
ToEntityId	Integer	False	No	EntityId of the redirect.
ToURL	String	False	No	URL of the redirect.
URL	String	False	No	Full destination URL for the redirect. Must be explicitly included via URL parameter.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	OrderItems.Id	No	Id of the Product within the order.
ProductId [KEY]	Integer	True	Products.Id	No	Numerical Id of the product.
OrderShipmentId [KEY]	String	True	OrderShipments.Id	No	Id of the shipment.
Quantity	Integer	False		No	Quantity of product shipped.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id	Integer	True		No	ID of the shipping quote.
OrderId	Integer	True	Orders.Id	No	Identifier for the BigCommerce Order with which this transaction is associated.
ShippingConsignmentId	Integer	True	ShippingConsignments.Id	No	ID of the shipping consignment.
UUID	String	True		No	UUID of the shipping quote.
Timestamp	String	True		No	Time the order was created in RFC 2822 format.
ProviderCode	String	True		No	Code of the shipping provider.
CarrierCode	String	True		No	Code of the shipping carrier.
RateCode	String	True		No	Type of delivery. This can vary based on shipping quote.
RateId	String	True		No	This can vary based on shipping quote.
MethodId	Integer	True		No	Shipping method ID.
ProviderQuoteRateValue	Integer	True		No	Provider quote's rate_value.
ProviderQuoteRateUnit	String	True		No	Provider quote's rate_unit.
ProviderQuoteName	String	True		No	Provider quote's name.
ProviderQuoteTransitTime	Integer	True		No	Provider quote's transitTime.
ProviderQuoteSignatureConfirmationFee	String	True		No	Provider quote's signatureConfirmationFee.
ProviderQuoteCarrierName	String	True		No	Provider quote's CarrierName.
ProviderQuoteDeliveryMessage	String	True		No	Provider quote's deliveryMessage.
ProviderQuoteLabelSizes	String	True		No	Provider quote's label sizes.
ProviderQuoteDates	String	True		No	Provider quote's dates.
ProviderQuoteInsuredMailFee	String	True		No	Provider quote's insuredMailFee.
ProviderQuoteRateId	String	True		No	Provider quote's rateId.
ProviderQuoteDescription	String	True		No	Provider quote's description.
ProviderQuoteAdditionalInfo	String	True		No	Provider quote's additionalInfo.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id	Integer	True		No	ID of the shipping consignment.
OrderId	Integer	True	Orders.Id	No	Identifier for the BigCommerce Order with which this transaction is associated.
FirstName	String	True		No	First name.
LastName	String	True		No	Last name.
Company	String	True		No	company.
Street1	String	True		No	Street address (first line).
Street2	String	True		No	Street address (second line).
Country	String	True		No	country
State	String	True		No	State
Email	String	True		No	Recipient?s email address.
Phone	String	True		No	Recipient?s telephone number.
ItemsTotal	String	True		No	The total number of items in the order.
ItemsShipped	String	True		No	The number of items that have been shipped.
ShippingMethod	String	True		No	Text identifying the BigCommerce shipping module selected by the customer.
BaseCost	Integer	True		No	The base shipping cost value.
CostExTax	Integer	True		No	The shipping cost value excluding tax.
CostIncTax	Integer	True		No	The shipping cost value including tax.
CostTax	Integer	True		No	The tax amount on the shipping cost.
CostTaxClassId	Integer	True		No	The ID of the tax class applied to the shipping cost. Ignored if automatic tax is enabled.
BaseHandlingCost	Integer	True		No	The base handling charge.
HandlingCostExTax	Integer	True		No	The handling charge, excluding tax.
HandlingCostIncTax	Integer	True		No	The handling charge, including tax.
HandlingCostTax	Integer	True		No	The handling charge, including tax number.
HandlingCostTaxClassId	Integer	True		No	The ID of the tax class applied to the handling charge. Ignored if automatic tax is enabled.
ShippingZoneId	Integer	True		No	The numeric ID of the shipping zone.
ShippingZoneName	String	True		No	The name of the shipping zone.
ShippingQuotesResources	String	True		No	URL where you can use a GET request to get the shipping quotes for the order consignment.
ShippingQuotesUrl	String	True		No	Path where you can use a GET request to get the shipping quotes for the order consignment.
ZipCode	String	True		No	zip code of the shipping quotes.
ShippingLineItemResources	String	True		No	URL where you can use a GET request to get the shipping line items for the order consignment.
ShippingLineItemUrl	String	True		No	Path where you can use a GET request to get the shipping line items for the order consignment.
City	String	True		No	Path where you can use a GET request to get the shipping line items for the order consignment.
CountryIso	String	True		No	Path where you can use a GET request to get the shipping line items for the order consignment.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	Shipping Method Id.
Name	String	False	No	Shipping Method name.
Type	String	False	No	Shipping Method type.
Enabled	Boolean	False	No	Minimum subtotal of the free shipping.
HandlingFeesPercentageSurcharge	Decimal	False	No	Percentage surcharge of the handling fee.
HandlingFeesFixedSurcharge	Decimal	False	No	Fixed surcharge of the handling fee.
IsFallback	Boolean	True	No	Whether or not this shipping zone is the fallback if all others are not valid for the order.
Settings	String	False	No	Shipping method settings.
ZoneId	Integer	True	No	The Shipping Zone Id

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	Zone Id.
Name	String	False	No	Zone name.
Type	String	False	No	Zone type.
FreeShippingEnabled	Boolean	False	No	Indicator if free shipping is enabled.
FreeShippingMinimumSubTotal	Decimal	False	No	Minimum subtotal of the free shipping.
FreeShippingExcludeFixedShippingProducts	Boolean	False	No	Indicator whether or not to exclude fixed shipping on products.
HandlingFeesDisplaySeparately	Boolean	False	No	Indicator whether or not to display the handling fees separately.
HandlingFeesPercentageSurcharge	Decimal	False	No	Percentage surcharge of the handling fee.
HandlingFeesFixedSurcharge	Decimal	False	No	Fixed surcharge of the handling fee.
Enabled	Boolean	False	No	Whether this shipping zone is enabled.
Locations	String	False	No	Array of zone locations.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	Unique store identifier.
Domain	String	False	No	Primary domain name.
SecureUrl	String	False	No	Stores current HTTPS URL.
Status	String	False	No	Status of the store.
Name	String	False	No	Stores name.
FirstName	String	False	No	Primary contacts first name
LastName	String	False	No	Primary contacts last name
Address	String	False	No	Display address.
Country	String	False	No	Country where the store is located
CountryCode	String	False	No	Country code.
Phone	String	False	No	Display phone number.
AdminEmail	String	False	No	Email address of the store administrator/owner.
OrderEmail	String	False	No	Email address for orders and fulfillment.
FaviconUrl	String	False	No	URL of the favicon.
TimezoneName	String	False	No	A string identifying the time zone, in the format: /.
TimezoneRawOffset	Integer	False	No	A negative or positive number, identifying the offset from UTC/GMT, in seconds, during winter/standard time.
Language	String	False	No	Default language code.
Currency	String	False	No	Default currency code
CurrencySymbol	String	False	No	Default symbol for values in the currency.
DecimalSeparator	String	False	No	Default decimal separator for values in the currency.
ThousandsSeparator	String	False	No	Default thousands separator for values in the currency.
DecimalPlaces	Integer	False	No	Default decimal places for values in the currency.
CurrencySymbolLocation	String	False	No	Default position of the currency symbol (left or right).
WeightUnits	String	False	No	Default weight units (metric or imperial).
DimensionUnits	String	False	No	Default dimension units (metric or imperial).
DimensionDecimalPlaces	Integer	False	No	The number of decimal places.
DimensionDecimalToken	String	False	No	The symbol that separates the whole numbers from the decimal points.
DimensionThousandsToken	String	False	No	The symbol used to denote thousands.
PlanName	String	False	No	Name of the BigCommerce plan to which this store is subscribed.
PlanLevel	String	False	No	Level of the BigCommerce plan to which this store is subscribed.
Industry	String	False	No	Industry, or vertical category, in which the business operates.
LogoUrl	String	False	No	URL of the logo.
IsPriceEnteredWithTax	Boolean	False	No	A Boolean value that indicates whether or not prices are entered with tax.
FeaturesStencilEnabled	Boolean	False	No	Indicates whether a store is using a Stencil theme.
FeaturesSitewideHttpsEnabled	Boolean	False	No	Indicates if there is sitewide https.
FeaturesFacebookCatalogId	String	False	No	Id of the facebook catalog. If there is none, it returns an empty string.
FeaturesCheckoutType	String	False	No	What type of checkout is enabled on the store.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Numeric ID of the tax class.
Name	String	False	No	Name of the tax class.
DateCreated	Date	False	No	The date when tax class was created.
DateModified	Date	False	No	The data when tax class was modified.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	False	No	Unique identifier for the transaction.
OrderId	String	False	No	Identifier for the BigCommerce Order with which this transaction is associated.
Event	String	False	No	Store event that created the transaction.
Method	String	False	No	The payment method.
Amount	Decimal	False	No	Amount of money in the transaction.
Currency	String	False	No	Currency used for the transaction.
Gateway	String	False	No	The payment gateway.
Status	String	False	No	Status of the transaction.
GatewayTransactionId	String	False	No	The transaction ID returned by the payment gateway for this transaction item.
DateCreated	Datetime	False	No	The datetime of the transaction.
Test	Boolean	False	No	True if the transaction performed was a test, or if the gateway is in test mode.
FraudReview	Boolean	False	No	Result of gateway fraud review, if any.
ReferenceTransactionId	Integer	False	No	Identifier for an existing transaction upon which this transaction acts.
OfflineDisplayName	String	False	No	Display name for the offline payment.
CustomPaymentMethod	String	False	No	Custom payment from manual order.
PaymentMethodId	String	False	No	The payment method ID used for this transaction.
PaymentInstrumentToken	String	False	No	Internal BigPay token for stored card.
AVSResultCode	String	False	No	AVS code from the payment gateway.
AVSResultMessage	String	False	No	AVS message from the payment gateway.
AVSResultStreetMatch	String	False	No	AVS Code for street matching result.
AVSResultPostalMatch	String	False	No	AVS Code for postal matching result.
CVVResultCode	String	False	No	CVV Code from the payment Gateway.
CVVResultMessage	String	False	No	CVV Message from the payment Gateway.
CreditCardType	String	False	No	Type of credit-card.
CreditCardIIN	String	False	No	The IIN of a credit-card number.
CreditCardLast4	String	False	No	The last 4 digits of a credit-card number.
CreditCardExpiryMonth	Integer	False	No	The expiry month of a credit-card.
CreditCardExpiryYear	Integer	False	No	The expiry year of a credit-card.
GiftCertificateCode	String	False	No	The gift-certificate code.
GiftCertificateOriginalBalance	Decimal	False	No	The balance on a gift certificate when it was purchased.
GiftCertificateStartingBalance	Decimal	False	No	The balance on a gift certificate at the time of this purchase.
GiftCertificateRemainingBalance	Decimal	False	No	The remaining balance on a gift certificate.
GiftCertificateStatus	String	False	No	The status of a gift certificate.
StoreCreditRemainingBalance	Decimal	False	No	Remaining balance of shopper's store credit.

Return to Top