Expand description
Python bindings for StateSet Embedded Commerce
Provides a local-first commerce library with SQLite storage.
from stateset_embedded import Commerce
commerce = Commerce("./store.db")
customer = commerce.customers.create(
email="alice@example.com",
first_name="Alice",
last_name="Smith"
)Structsยง
- Accounts
Payable Api - Accounts
Receivable Api - AddCart
Item Input - Input for adding a cart item.
- Analytics
- Business intelligence and forecasting operations.
- ApAging
Summary - Applied
Promotion - An applied promotion
- Apply
Promotions Result - Result of applying promotions
- ArAging
Summary - Backorder
- Backorder
Api - Backorder
Summary - Bill
- Billing
Cycle - Billing cycle data.
- Bom
- Bill of Materials data.
- BomApi
- Bill of Materials management operations.
- BomComponent
- BOM component data.
- Canadian
TaxInfo - Canadian tax info.
- Cart
- Cart data returned from operations.
- Cart
Address - Cart address data.
- Cart
Item - Cart item data.
- Carts
- Cart and checkout management operations.
- Checkout
Result - Checkout result returned when completing a cart.
- Commerce
- Main Commerce instance for local commerce operations.
- Conversion
Result - Result of a currency conversion.
- Cost
Accounting Api - Coupon
- Coupon code output
- Create
Order Item Input - Input for creating an order item.
- Create
Product Variant Input - Input for creating a product variant.
- Create
Return Item Input - Input for creating a return item.
- Credit
Account - Credit
Api - Credit
Check Result - Credit
Memo - Currency
Operations - Currency and exchange rate operations.
- Custom
Field Definition - Custom field definition (output).
- Custom
Field Definition Input - Input for defining a custom field in a type schema.
- Custom
Object - Custom object record output.
- Custom
Object Type - Custom object type (schema) output.
- Custom
Objects Api - Custom objects API for defining schemas and storing typed records.
- Customer
- Customer data returned from operations.
- Customer
Metrics - Customer segment metrics.
- Customer
Search Result - Customer search result with similarity score.
- Customers
- Customer management operations.
- Demand
Forecast - Demand forecast for a SKU.
- Embedding
Stats - Embedding statistics.
- EuVat
Info - EU VAT info.
- Exchange
Rate - Exchange rate between currencies.
- Fulfillment
Api - Fulfillment
Metrics - Order fulfillment metrics.
- General
Ledger Api - GlAccount
- Inspection
- Inventory
- Inventory management operations.
- Inventory
Health - Inventory health summary.
- Inventory
Item - Inventory item data.
- Inventory
Movement - Inventory movement summary.
- Inventory
Valuation - Invoice
- Invoice data.
- Invoices
- Invoice management operations.
- Item
Cost - Journal
Entry - Lot
- LotsApi
- LowStock
Item - Low stock item.
- NonConformance
- Order
- Order data returned from operations.
- Order
Item - Order line item.
- Order
Status Breakdown - Order status breakdown.
- Orders
- Order management operations.
- Payment
- Payment data returned from operations.
- Payments
- Payment processing operations.
- Pick
Task - Product
- Product data returned from operations.
- Product
Performance - Product performance with period comparison.
- Product
Search Result - Product search result with similarity score.
- Product
Variant - Product variant data.
- Products
- Product catalog operations.
- Promotion
- Promotion output
- Promotion
Usage - Promotion usage record
- Promotions
Api - Promotions API for managing discounts and coupon codes
- Purchase
Order - Purchase order data.
- Purchase
Orders - Purchase order management operations.
- Quality
Api - Quality
Hold - Receipt
- Receipt
Line - Receiving
Api - Refund
- Refund data returned from operations.
- Reservation
- Inventory reservation.
- Return
- Return request data.
- Return
Metrics - Return metrics.
- Returns
- Return processing operations.
- Revenue
ByPeriod - Revenue metrics grouped by time period.
- Revenue
Forecast - Revenue forecast.
- Sales
Summary - Sales summary metrics.
- Serial
Number - Serials
Api - SetExchange
Rate Input - Input for setting an exchange rate.
- Shipment
- Shipment data returned from operations.
- Shipments
- Shipment management operations.
- Shipping
Rate - Shipping rate option.
- Stock
Level - Stock level information.
- Store
Currency Settings - Store currency settings.
- Subscription
- Subscription data.
- Subscription
Event - Subscription event data.
- Subscription
Plan - Subscription plan data.
- Subscriptions
- Subscriptions API for subscription management.
- Supplier
- Supplier data.
- TaxApi
- Tax operations API.
- TaxCalculation
Result - Tax calculation result.
- TaxExemption
- Tax exemption data.
- TaxJurisdiction
- Tax jurisdiction data.
- TaxRate
- Tax rate data.
- TaxSettings
- Tax settings data.
- TopCustomer
- Top customer by spend.
- TopProduct
- Top selling product metrics.
- Trial
Balance - UsState
TaxInfo - US state tax info.
- Vector
Search - Vector search API for semantic similarity search.
- Warehouse
- Warehouse
Api - Warehouse
Location - Warranties
- Warranty management operations.
- Warranty
- Warranty data returned from operations.
- Warranty
Claim - Warranty claim data.
- Wave
- Work
Order - Work order data.
- Work
Orders - Work order management operations.