API surface

Admin REST patterns for products, orders, customers, and related resources are mapped into entities and commands. Exact routes and versioning follow Shopify’s Admin API conventions implemented in the datasource.

Source & IDataSource

Implementation: Connectors/E-commerce/ShopifyDataSource/ShopifyDataSource.cs — ShopifyDataSource : WebAPIDataSource. Admin REST resources are exposed as entities; strongly typed commands attach the datasource to returned models for follow-up calls.

Command methods (CommandAttribute)

NameMethodReturnsObjectType
GetProductsGetProducts(List<AppFilter>? filters = null)Task<IEnumerable<Product>>Product
GetOrdersGetOrders(List<AppFilter>? filters = null)Task<IEnumerable<Order>>Order
GetCustomersGetCustomers(List<AppFilter>? filters = null)Task<IEnumerable<Customer>>Customer
GetInventoryItemsGetInventoryItems(List<AppFilter>? filters = null)Task<IEnumerable<InventoryItem>>InventoryItem
GetLocationsGetLocations(List<AppFilter>? filters = null)Task<IEnumerable<Location>>Location
GetCustomCollectionsGetCustomCollections(List<AppFilter>? filters = null)Task<IEnumerable<CustomCollection>>CustomCollection
GetSmartCollectionsGetSmartCollections(List<AppFilter>? filters = null)Task<IEnumerable<SmartCollection>>SmartCollection
CreateProductCreateProductAsync(Product product)Task<IEnumerable<Product>>Product
UpdateProductUpdateProductAsync(Product product)Task<IEnumerable<Product>>Product
CreateOrderCreateOrderAsync(Order order)Task<IEnumerable<Order>>Order
UpdateOrderUpdateOrderAsync(Order order)Task<IEnumerable<Order>>Order
CreateCustomerCreateCustomerAsync(Customer customer)Task<IEnumerable<Customer>>Customer
UpdateCustomerUpdateCustomerAsync(Customer customer)Task<IEnumerable<Customer>>Customer
CreateInventoryItemCreateInventoryItemAsync(InventoryItem inventoryItem)Task<IEnumerable<InventoryItem>>InventoryItem
UpdateInventoryItemUpdateInventoryItemAsync(InventoryItem inventoryItem)Task<IEnumerable<InventoryItem>>InventoryItem
CreateLocationCreateLocationAsync(Location location)Task<IEnumerable<Location>>Location
UpdateLocationUpdateLocationAsync(Location location)Task<IEnumerable<Location>>Location
CreateCustomCollectionCreateCustomCollectionAsync(CustomCollection customCollection)Task<IEnumerable<CustomCollection>>CustomCollection
UpdateCustomCollectionUpdateCustomCollectionAsync(CustomCollection customCollection)Task<IEnumerable<CustomCollection>>CustomCollection
CreateSmartCollectionCreateSmartCollectionAsync(SmartCollection smartCollection)Task<IEnumerable<SmartCollection>>SmartCollection
UpdateSmartCollectionUpdateSmartCollectionAsync(SmartCollection smartCollection)Task<IEnumerable<SmartCollection>>SmartCollection

Model types

TheTechIdea.Beep.Connectors.Ecommerce.Shopify.Models — Product, Order, Customer, InventoryItem, Location, CustomCollection, SmartCollection, and nested types in the Shopify connector project.

Connection

Shop domain and access token (private app or OAuth) map through WebAPIConnectionProperties. Rate limits and API version headers are Shopify-specific.

Also read