Explore the BigCommerce API data model

See how the various BigCommerce endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the BigCommerce API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your BigCommerce API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Brand

Documentation: https://developer.bigcommerce.com/docs/rest-catalog/category-trees/brands

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
PageTitle string - -
SearchKeywords string - -
MetaDescription string - -
ImgUrl string - -

Category

Documentation: https://developer.bigcommerce.com/docs/rest-catalog/category-trees/categories

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Description string - -
CategoryID long - -
ParentID long Category → CategoryID -
TreeID long - -
PageTitle string - -
SearchKeywords string - -
MetaDescription string - -
DefaultProductSort string - -
IsVisible boolean - -
Views int - -
SortOrder int - -

Product

Documentation: https://developer.bigcommerce.com/docs/rest-catalog/products

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Type string - -
Sku string - -
Weight decimal - -
Width decimal - -
Depth decimal - -
Height decimal - -
Price decimal - -
CostPrice decimal - -
RetailPrice decimal - -
SalePrice decimal - -
MapPrice decimal - -
TaxClassID long TaxClass → ID -
CalculatedPrice decimal - -
ProductTaxCode string - -
BrandID long Brand → ID -
InventoryLevel int - -
InventoryWarningLevel int - -
InventoryTracking string - -
FixedCostShippingPricenumber decimal - -
IsFreeShipping boolean - -
IsVisible boolean - -
IsFeatured boolean - -
Warranty string - -
BinPickingNumber string - -
LayoutFile string - -
Upc string - -
SearchKeywords string - -
AvailabilityDescription string - -
Availability string - -
GiftWrappingOptionsType string - -
SortOrder int - -
Condition string - -
IsConditionShown boolean - -
OrderQuantityMinimum decimal - -
OrderQuantityMaximum decimal - -
PageTitle string - -
MetaDescription string - -
ViewCount int - -
PreorderReleaseDate datetime - -
PreorderMessage string - -
IsPreorderOnly boolean - -
IsPriceHidden boolean - -
PriceHiddenLabel string - -
OpenGraphType string - -
OpenGraphTitle string - -
OpenGraphDescription string - -
OpenGraphUseMetaDescription boolean - -
OpenGraphUseProductName boolean - -
OpenGraphUseImage boolean - -
Gtin string - -
Mpn string - -
DateLastImported datetime - -
ReviewsRatingSum int - -
ReviewsCount int - -
TotalSold int - -
BaseVariantID long ProductVariant → ID -
DateCreated datetime - -
DateModified datetime - -

Channel

Documentation: https://developer.bigcommerce.com/docs/rest-management/channels

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Platform string - -
Type string - -
Status string - -
ExternalID string - -
IconUrl string - -
IsEnabled boolean - -
IsVisible boolean - -
IsListableFromUi boolean - -
DateCreated datetime - -
DateModified datetime - -

Customer

Documentation: https://developer.bigcommerce.com/docs/rest-management/customers

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Company string - -
Email string - -
CustomerGroupID long - -
OriginChannelID long Channel → ID -
FirstName string - -
LastName string - -
Notes string - -
Phone string - -
RegistrationIpAddress string - -
AcceptsProductReviewAbandonedCartEmails boolean - -

Location

Documentation: https://developer.bigcommerce.com/docs/rest-management/locations

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Code string - -
Label string - -
ManagedByExternalSource boolean - -
Enabled boolean - -
StorefrontVisibility boolean - -
TypeID string - -
DateCreated datetime - -
DateModified datetime - -

Order

Documentation: https://developer.bigcommerce.com/docs/rest-management/orders

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
CustomerID long Customer → ID -
ChannelID long Channel → ID -
IsTaxInclusivePricing boolean - -
DateCreated datetime - -
DateModified datetime - -
DateShipped datetime - -
Status string - -
SubtotalExTax decimal - -
SubtotalIncTax decimal - -
SubtotalTax decimal - -
BaseShippingCost decimal - -
ShippingCostExTax decimal - -
ShippingCostIncTax decimal - -
ShippingCostTax decimal - -
BaseHandlingCost decimal - -
HandlingCostExTax decimal - -
HandlingCostIncTax decimal - -
HandlingCostTax decimal - -
ShippingCostTaxClassID long TaxClass → ID -
HandlingCostTaxClassID long TaxClass → ID -
WrappingCostTaxClassID long TaxClass → ID -
BaseWrappingCost decimal - -
WrappingCostExTax decimal - -
WrappingCostIncTax decimal - -
WrappingCostTax decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -
TotalTax decimal - -
ItemsTotal long - -
ItemsShipped long - -
PaymentMethod string - -
PaymentProviderID string - -
PaymentStatus string - -
RefundedAmount decimal - -
OrderIsDigital boolean - -
StoreCreditAmount decimal - -
GiftCertificateAmount decimal - -
IpAddress string - -
IpAddressV6 string - -
GeoipCountry string - -
GeoipCountryIso2 string - -
CurrencyID long - -
DefaultCurrencyID long - -
CurrencyCode string - -
CurrencyExchangeRate decimal - -
DefaultCurrencyCode string - -
StaffNotes string - -
CustomerMessage string - -
CustomStatus string - -
StoreDefaultCurrencyCode string - -
CustomerLocale string - -
TaxProviderID string - -
DiscountAmount decimal - -
StoreDefaultToTransactionalExchangeRate decimal - -
CouponDiscount decimal - -
ShippingAddressCount int - -
CartID guid - -
IsEmailOptIn boolean - -
BillingAddressFirstName string - -
BillingAddressLastName string - -
BillingAddressCompany string - -
BillingAddressStreet1 string - -
BillingAddressStreet2 string - -
BillingAddressCity string - -
BillingAddressZip string - -
BillingAddressCountry string - -
BillingAddressCountryIso2 string - -
BillingAddressState string - -
BillingAddressEmail string - -
BillingAddressPhone string - -

Site

Documentation: https://developer.bigcommerce.com/docs/rest-management/sites

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Url string - -
ChannelID long Channel → ID -

TaxClass

Documentation: https://developer.bigcommerce.com/docs/rest-management/tax-classes

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
DateCreated datetime - -
DateModified datetime - -

TaxRate

Documentation: https://developer.bigcommerce.com/docs/rest-management/tax-rates

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Enabled boolean - -
Priority int - -
TaxZoneID long TaxZone → ID -

TaxZone

Documentation: https://developer.bigcommerce.com/docs/rest-management/tax-zones

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
PriceDisplaySettingsShowInclusive boolean - -
PriceDisplaySettingsShowBothOnDetailView boolean - -
PriceDisplaySettingsShowBothOnListView boolean - -
Enabled boolean - -

ProductCategory

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID long Product → ID -
CategoryID long - -

ProductVariant

Documentation: https://developer.bigcommerce.com/docs/rest-catalog/product-variants

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
ProductID long Product → ID -
CalculatedPrice decimal - -
Price decimal - -
SkuID long - -
Depth decimal - -
Height decimal - -
CostPrice decimal - -
RetailPrice decimal - -
SalePrice decimal - -
MapPrice decimal - -
FixedCostShippingPrice decimal - -
PurchasingDisabled boolean - -
CalculatedWeight decimal - -
ImageUrl string - -
Upc string - -
Mpn string - -
Gtin string - -
InventoryLevel int - -
InventoryWarningLevel int - -
BinPickingNumber string - -

ProductVariantOption

Documentation: https://developer.bigcommerce.com/docs/rest-catalog/product-variant-options

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
ProductID long Product → ID -
DisplayName string - -
Type string - -
SortOrder int - -

CustomerAddress

Documentation: https://developer.bigcommerce.com/docs/rest-management/customers/addresses

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
CustomerID long Customer → ID -
Address1 string - -
Address2 string - -
AddressType string - -
City string - -
Company string - -
Country string - -
CountryCode string - -
FirstName string - -
LastName string - -
Phone string - -
PostalCode string - -
StateOrProvince string - -
DateCreated datetime - -
DateModified datetime - -

LocationOperatingHours

Column Type Relates to Notes
RemoteID string - -
LocationRemoteID string Location → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LocationID long Location → ID -
DayName string - -
Open boolean - -
Opening string - -
Closing string - -

ShippingConsignment

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
FirstName string - -
LastName string - -
Company string - -
Street1 string - -
Street2 string - -
City string - -
Zip string - -
Country string - -
CountryIso2 string - -
State string - -
Email string - -
Phone string - -
OrderID long Order → ID -

DigitalConsignment

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrderID long Order → ID -
RecipientEmail string - -

SiteUrl

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SiteID long Site → ID -
Iterator int - -
Url string - -
Type string - -
DateCreated datetime - -
DateModified datetime - -

TaxRateClassRate

Column Type Relates to Notes
RemoteID string - -
TaxRateRemoteID string TaxRate → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaxRateID long TaxRate → ID -
Rate decimal - -
TaxClassID long TaxClass → ID -

ProductVariantOptionSelectedValue

Column Type Relates to Notes
RemoteID string - -
ProductVariantRemoteID string ProductVariant → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long ProductVariantOptionValue → ID -
ProductVariantID long ProductVariant → ID -

ProductVariantOptionValue

Column Type Relates to Notes
RemoteID string - -
ProductVariantOptionRemoteID string ProductVariantOption → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
ProductVariantOptionID long ProductVariantOption → ID -
SortOrder int - -
Label string - -
IsDefault boolean - -

ShippingConsignmentLine

Column Type Relates to Notes
RemoteID string - -
ShippingConsignmentRemoteID string ShippingConsignment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
ShippingConsignmentID long ShippingConsignment → ID -
ProductID long Product → ID -
VariantID long ProductVariant → ID -
Quantity int - -
QuantityShipped int - -
IsRefunded boolean - -
IsBundledProduct boolean - -
QuantityRefunded int - -
RefundAmount decimal - -
WrappingName string - -
WrappingMessage string - -
BaseWrappingCost decimal - -
WrappingCostExTax decimal - -
FixedShippingCost decimal - -
DiscountedTotalIncTax decimal - -
EventName string - -
EventDate datetime - -
BinPickingNumber string - -

DigitalConsignmentLine

Column Type Relates to Notes
RemoteID string - -
DigitalConsignmentRemoteID string DigitalConsignment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
DigitalConsignmentID string DigitalConsignment → RemoteID -
ProductID long Product → ID -
VariantID long ProductVariant → ID -
Quantity int - -
QuantityShipped int - -
IsRefunded boolean - -
IsBundledProduct boolean - -
QuantityRefunded int - -
RefundAmount decimal - -
WrappingName string - -
WrappingMessage string - -
BaseWrappingCost decimal - -
WrappingCostExTax decimal - -
FixedShippingCost decimal - -
DiscountedTotalIncTax decimal - -
EventName string - -
EventDate datetime - -
BinPickingNumber string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own BigCommerce data Querying BigCommerce using regular SQL