Services ​
- Type
- Trait
- Namespace
- craft\commerce\plugin
- Implemented by
- craft\commerce\Plugin
- Since
- 2.0
Trait Services
Public Properties ​
cart ​
- Type
- craft\commerce\services\Carts
- Default value
null
the cart service
catalogPricing ​
- Type
- craft\commerce\services\CatalogPricing
- Default value
null
the catalog pricing rules service
catalogPricingRules ​
- Type
- craft\commerce\services\CatalogPricingRules
- Default value
null
the catalog pricing rules service
currencies ​
- Type
- craft\commerce\services\Currencies
- Default value
null
the currencies service
customers ​
- Type
- craft\commerce\services\Customers
- Default value
null
the customers service
discounts ​
- Type
- craft\commerce\services\Discounts
- Default value
null
the discounts service
emails ​
- Type
- craft\commerce\services\Emails
- Default value
null
the emails service
gateways ​
- Type
- craft\commerce\services\Gateways
- Default value
null
the gateways service
lineItems ​
- Type
- craft\commerce\services\LineItems
- Default value
null
the line items service
orderAdjustments ​
- Type
- craft\commerce\services\OrderAdjustments
- Default value
null
the order adjustments service
orderHistories ​
- Type
- craft\commerce\services\OrderHistories
- Default value
null
the order histories service
orderNotices ​
- Type
- craft\commerce\services\OrderStatuses
- Default value
null
the order notices service
orderStatuses ​
- Type
- craft\commerce\services\OrderStatuses
- Default value
null
the orderStatuses service
orders ​
- Type
- craft\commerce\services\Orders
- Default value
null
the orders service
paymentCurrencies ​
- Type
- craft\commerce\services\PaymentCurrencies
- Default value
null
the paymentCurrencies service
paymentSources ​
- Type
- craft\commerce\services\PaymentSources
- Default value
null
the payment sources service
payments ​
- Type
- craft\commerce\services\Payments
- Default value
null
the payments service
pdf ​
- Type
- craft\commerce\services\Pdfs
- Default value
null
the pdf service
plans ​
- Type
- craft\commerce\services\Plans
- Default value
null
the plans service
productTypes ​
- Type
- craft\commerce\services\ProductTypes
- Default value
null
the product types service
products ​
- Type
- craft\commerce\services\Products
- Default value
null
the products service
purchasables ​
- Type
- craft\commerce\services\Purchasables
- Default value
null
the purchasables service
sales ​
- Type
- craft\commerce\services\Sales
- Default value
null
the sales service
shippingCategories ​
- Type
- craft\commerce\services\ShippingCategories
- Default value
null
the shipping categories service
shippingMethods ​
- Type
- craft\commerce\services\ShippingMethods
- Default value
null
the shipping methods service
shippingRuleCategories ​
- Type
- craft\commerce\services\ShippingRuleCategories
- Default value
null
the shipping rule categories service
shippingRules ​
- Type
- craft\commerce\services\ShippingRules
- Default value
null
the shipping rules service
shippingZones ​
- Type
- craft\commerce\services\ShippingZones
- Default value
null
the shipping zones service
subscriptions ​
- Type
- craft\commerce\services\Subscriptions
- Default value
null
the subscriptions service
taxCategories ​
- Type
- craft\commerce\services\TaxCategories
- Default value
null
the taxCategories service
taxRates ​
- Type
- craft\commerce\services\TaxRates
- Default value
null
the taxRates service
taxZones ​
- Type
- craft\commerce\services\TaxZones
- Default value
null
the taxZones service
transactions ​
- Type
- craft\commerce\services\Transactions
- Default value
null
the transactions service
variants ​
- Type
- craft\commerce\services\Variants
- Default value
null
the variants service
Public Methods ​
| Method | Description |
|---|---|
| getCarts() | Returns the cart service |
| getCatalogPricing() | Returns the catalog pricing service |
| getCatalogPricingRules() | Returns the catalog pricing rules service |
| getCoupons() | Returns the coupons service |
| getCurrencies() | Returns the currencies service |
| getCustomers() | Returns the customers service |
| getDiscounts() | Returns the discounts service |
| getEmails() | Returns the emails service |
| getFormulas() | Returns the formulas service |
| getGateways() | Returns the gateways service |
| getInventory() | Returns the inventory service |
| getInventoryLocations() | Returns the inventory locations service |
| getLineItemStatuses() | Returns the lineItems statuses service |
| getLineItems() | Returns the lineItems service |
| getOrderAdjustments() | Returns the orderAdjustments service |
| getOrderHistories() | Returns the orderHistories service |
| getOrderNotices() | Returns the OrderNotices service |
| getOrderStatuses() | Returns the OrderStatuses service |
| getOrders() | Returns the orders service |
| getPaymentCurrencies() | Returns the paymentCurrencies service |
| getPaymentSources() | Returns the payment sources service |
| getPayments() | Returns the payments service |
| getPdfs() | Returns the PDFs service |
| getPlans() | Returns the payment sources service |
| getProductTypes() | Returns the productTypes service |
| getProducts() | Returns the products service |
| getPurchasables() | Returns the purchasables service |
| getSales() | Returns the sales service |
| getShippingCategories() | Returns the shippingCategories service |
| getShippingMethods() | Returns the shippingMethods service |
| getShippingRuleCategories() | Returns the shippingRules service |
| getShippingRules() | Returns the shippingRules service |
| getShippingZones() | Returns the shippingZones service |
| getStore() | Returns the stores service |
| getStoreSettings() | Returns the store service |
| getStores() | Returns the stores service |
| getSubscriptions() | Returns the subscriptions service |
| getTaxCategories() | Returns the taxCategories service |
| getTaxRates() | Returns the taxRates service |
| getTaxZones() | Returns the taxZones service |
| getTaxes() | Returns the taxes service |
| getTransactions() | Returns the transactions service |
| getTransfers() | Returns the transfers service |
| getVariants() | Returns the variants service |
| getVat() | Returns the VAT service |
| getWebhooks() | Returns the webhooks service |
getCarts() ​
Returns the cart service
Returns ​
craft\commerce\services\Carts – The cart service
Throws ​
getCatalogPricing() ​
Returns the catalog pricing service
Returns ​
craft\commerce\services\CatalogPricing
Throws ​
getCatalogPricingRules() ​
Returns the catalog pricing rules service
Returns ​
craft\commerce\services\CatalogPricingRules
Throws ​
getCoupons() ​
Returns the coupons service
Returns ​
craft\commerce\services\Coupons – The countries service
Throws ​
getCurrencies() ​
Returns the currencies service
Returns ​
craft\commerce\services\Currencies – The currencies service
Throws ​
getCustomers() ​
Returns the customers service
Returns ​
craft\commerce\services\Customers – The customers service
Throws ​
getDiscounts() ​
Returns the discounts service
Returns ​
craft\commerce\services\Discounts – The discounts service
Throws ​
getEmails() ​
Returns the emails service
Returns ​
craft\commerce\services\Emails – The emails service
Throws ​
getFormulas() ​
- Since
- 2.2
Returns the formulas service
Returns ​
craft\commerce\services\Formulas – The formulas service
Throws ​
getGateways() ​
Returns the gateways service
Returns ​
craft\commerce\services\Gateways – The gateways service
Throws ​
getInventory() ​
Returns the inventory service
Returns ​
craft\commerce\services\Inventory – The inventory service
Throws ​
getInventoryLocations() ​
Returns the inventory locations service
Returns ​
craft\commerce\services\InventoryLocations – The inventory locations service
Throws ​
getLineItemStatuses() ​
Returns the lineItems statuses service
Returns ​
craft\commerce\services\LineItemStatuses – The lineItems service
Throws ​
getLineItems() ​
Returns the lineItems service
Returns ​
craft\commerce\services\LineItems – The lineItems service
Throws ​
getOrderAdjustments() ​
Returns the orderAdjustments service
Returns ​
craft\commerce\services\OrderAdjustments – The orderAdjustments service
Throws ​
getOrderHistories() ​
Returns the orderHistories service
Returns ​
craft\commerce\services\OrderHistories – The orderHistories service
Throws ​
getOrderNotices() ​
Returns the OrderNotices service
Returns ​
craft\commerce\services\OrderNotices – The OrderNotices service
Throws ​
getOrderStatuses() ​
Returns the OrderStatuses service
Returns ​
craft\commerce\services\OrderStatuses – The OrderStatuses service
Throws ​
getOrders() ​
Returns the orders service
Returns ​
craft\commerce\services\Orders – The orders service
Throws ​
getPaymentCurrencies() ​
Returns the paymentCurrencies service
Returns ​
craft\commerce\services\PaymentCurrencies – The paymentCurrencies service
Throws ​
getPaymentSources() ​
Returns the payment sources service
Returns ​
craft\commerce\services\PaymentSources – The payment sources service
Throws ​
getPayments() ​
Returns the payments service
Returns ​
craft\commerce\services\Payments – The payments service
Throws ​
getPdfs() ​
Returns the PDFs service
Returns ​
craft\commerce\services\Pdfs – The PDFs service
Throws ​
getPlans() ​
Returns the payment sources service
Returns ​
craft\commerce\services\Plans – The subscription plans service
Throws ​
getProductTypes() ​
Returns the productTypes service
Returns ​
craft\commerce\services\ProductTypes – The productTypes service
Throws ​
getProducts() ​
Returns the products service
Returns ​
craft\commerce\services\Products – The products service
Throws ​
getPurchasables() ​
Returns the purchasables service
Returns ​
craft\commerce\services\Purchasables – The purchasables service
Throws ​
getSales() ​
Returns the sales service
Returns ​
craft\commerce\services\Sales – The sales service
Throws ​
getShippingCategories() ​
Returns the shippingCategories service
Returns ​
craft\commerce\services\ShippingCategories – The shippingCategories service
Throws ​
getShippingMethods() ​
Returns the shippingMethods service
Returns ​
craft\commerce\services\ShippingMethods – The shippingMethods service
Throws ​
getShippingRuleCategories() ​
Returns the shippingRules service
Returns ​
craft\commerce\services\ShippingRuleCategories – The shippingRuleCategories service
Throws ​
getShippingRules() ​
Returns the shippingRules service
Returns ​
craft\commerce\services\ShippingRules – The shippingRules service
Throws ​
getShippingZones() ​
Returns the shippingZones service
Returns ​
craft\commerce\services\ShippingZones – The shippingZones service
Throws ​
getStore() ​
Returns the stores service
Returns ​
craft\commerce\services\Store – The store service
Throws ​
getStoreSettings() ​
Returns the store service
Returns ​
craft\commerce\services\StoreSettings – The store service
Throws ​
getStores() ​
Returns the stores service
Returns ​
craft\commerce\services\Stores – The stores service
Throws ​
getSubscriptions() ​
Returns the subscriptions service
Returns ​
craft\commerce\services\Subscriptions – The subscriptions service
Throws ​
getTaxCategories() ​
Returns the taxCategories service
Returns ​
craft\commerce\services\TaxCategories – The taxCategories service
Throws ​
getTaxRates() ​
Returns the taxRates service
Returns ​
craft\commerce\services\TaxRates – The taxRates service
Throws ​
getTaxZones() ​
Returns the taxZones service
Returns ​
craft\commerce\services\TaxZones – The taxZones service
Throws ​
getTaxes() ​
Returns the taxes service
Returns ​
craft\commerce\services\Taxes – The taxes service
Throws ​
getTransactions() ​
Returns the transactions service
Returns ​
craft\commerce\services\Transactions – The transactions service
Throws ​
getTransfers() ​
Returns the transfers service
Returns ​
craft\commerce\services\Transfers – The transfers service
Throws ​
getVariants() ​
Returns the variants service
Returns ​
craft\commerce\services\Variants – The variants service
Throws ​
getVat() ​
Returns the VAT service
Returns ​
craft\commerce\services\Vat – The VAT service
Throws ​
getWebhooks() ​
- Since
- 3.1.9
Returns the webhooks service
Returns ​
craft\commerce\services\Webhooks – The variants service