Entities & commands

v3 REST patterns for catalog and operations; CommandAttribute surfaces typed helpers (e.g. Products, Categories). See BigCommerceDataSource.cs for the full list and DTOs under Models.

Source & IDataSource

Implementation: Connectors/E-commerce/BigCommerceDataSource/BigCommerceDataSource.cs — BigCommerceDataSource : WebAPIDataSource. List operations call GetEntityAsync with a single AppFilter; create/update paths use PostAsync / PutAsync on relative resource paths (products, orders/{id}, …).

Command methods (CommandAttribute)

Read helpers below omit an explicit Name on the attribute; the registered command name matches the C# method name (GetProducts, …).

Name / methodSignatureReturnsObjectType
GetProductsGetProducts(AppFilter filter)Task<IEnumerable<BigCommerceProduct>>Products
GetCategoriesGetCategories(AppFilter filter)Task<IEnumerable<BigCommerceCategory>>Categories
GetBrandsGetBrands(AppFilter filter)Task<IEnumerable<BigCommerceBrand>>Brands
GetCustomersGetCustomers(AppFilter filter)Task<IEnumerable<BigCommerceCustomer>>Customers
GetOrdersGetOrders(AppFilter filter)Task<IEnumerable<BigCommerceOrder>>Orders
GetCartsGetCarts(AppFilter filter)Task<IEnumerable<BigCommerceCart>>Carts
GetCouponsGetCoupons(AppFilter filter)Task<IEnumerable<BigCommerceCoupon>>Coupons
GetInventoryGetInventory(AppFilter filter)Task<IEnumerable<BigCommerceInventoryItem>>Inventory
CreateProductCreateProductAsync(BigCommerceProduct product)Task<IEnumerable<BigCommerceProduct>>Products
UpdateProductUpdateProductAsync(BigCommerceProduct product)Task<IEnumerable<BigCommerceProduct>>Products
CreateCategoryCreateCategoryAsync(BigCommerceCategory category)Task<IEnumerable<BigCommerceCategory>>Categories
UpdateCategoryUpdateCategoryAsync(BigCommerceCategory category)Task<IEnumerable<BigCommerceCategory>>Categories
CreateBrandCreateBrandAsync(BigCommerceBrand brand)Task<IEnumerable<BigCommerceBrand>>Brands
UpdateBrandUpdateBrandAsync(BigCommerceBrand brand)Task<IEnumerable<BigCommerceBrand>>Brands
CreateCustomerCreateCustomerAsync(BigCommerceCustomer customer)Task<IEnumerable<BigCommerceCustomer>>Customers
UpdateCustomerUpdateCustomerAsync(BigCommerceCustomer customer)Task<IEnumerable<BigCommerceCustomer>>Customers
CreateOrderCreateOrderAsync(BigCommerceOrder order)Task<IEnumerable<BigCommerceOrder>>Orders
UpdateOrderUpdateOrderAsync(BigCommerceOrder order)Task<IEnumerable<BigCommerceOrder>>Orders
CreateCartCreateCartAsync(BigCommerceCart cart)Task<IEnumerable<BigCommerceCart>>Carts
UpdateCartUpdateCartAsync(BigCommerceCart cart)Task<IEnumerable<BigCommerceCart>>Carts
CreateCouponCreateCouponAsync(BigCommerceCoupon coupon)Task<IEnumerable<BigCommerceCoupon>>Coupons
UpdateCouponUpdateCouponAsync(BigCommerceCoupon coupon)Task<IEnumerable<BigCommerceCoupon>>Coupons
CreateInventoryItemCreateInventoryItemAsync(BigCommerceInventoryItem inventoryItem)Task<IEnumerable<BigCommerceInventoryItem>>Inventory
UpdateInventoryItemUpdateInventoryItemAsync(BigCommerceInventoryItem inventoryItem)Task<IEnumerable<BigCommerceInventoryItem>>Inventory

Model types

TheTechIdea.Beep.Connectors.Ecommerce.BigCommerceDataSource.Models — BigCommerceProduct, BigCommerceCategory, BigCommerceBrand, BigCommerceCustomer, BigCommerceOrder, BigCommerceCart, BigCommerceCoupon, BigCommerceInventoryItem, and related nested types in Models.cs (plus additional catalog/order shapes the datasource can deserialize).

Connection

Use WebAPIConnectionProperties with store hash / API path and X-Auth-Token (or OAuth) per BigCommerce API keys documentation.

Also read