Services

Type
Trait
Namespace
craft\commerce\plugin
Implemented by
craft\commerce\Plugin
Since
2.0

Trait Services

View source (opens new window)

# Public Properties

Property Description
cart craft\commerce\services\Carts – the cart service
currencies craft\commerce\services\Currencies – the currencies service
customers craft\commerce\services\Customers – the customers service
discounts craft\commerce\services\Discounts – the discounts service
emails craft\commerce\services\Emails – the emails service
gateways craft\commerce\services\Gateways – the gateways service
lineItems craft\commerce\services\LineItems – the line items service
orderAdjustments craft\commerce\services\OrderAdjustments – the order adjustments service
orderHistories craft\commerce\services\OrderHistories – the order histories service
orderNotices craft\commerce\services\OrderStatuses – the order notices service
orderStatuses craft\commerce\services\OrderStatuses – the orderStatuses service
orders craft\commerce\services\Orders – the orders service
paymentCurrencies craft\commerce\services\PaymentCurrencies – the paymentCurrencies service
paymentSources craft\commerce\services\PaymentSources – the payment sources service
payments craft\commerce\services\Payments – the payments service
pdf craft\commerce\services\Pdfs – the pdf service
plans craft\commerce\services\Plans – the plans service
productTypes craft\commerce\services\ProductTypes – the product types service
products craft\commerce\services\Products – the products service
purchasables craft\commerce\services\Purchasables – the purchasables service
sales craft\commerce\services\Sales – the sales service
shippingCategories craft\commerce\services\ShippingCategories – the shipping categories service
shippingMethods craft\commerce\services\ShippingMethods – the shipping methods service
shippingRuleCategories craft\commerce\services\ShippingRuleCategories – the shipping rule categories service
shippingRules craft\commerce\services\ShippingRules – the shipping rules service
shippingZones craft\commerce\services\ShippingZones – the shipping zones service
subscriptions craft\commerce\services\Subscriptions – the subscriptions service
taxCategories craft\commerce\services\TaxCategories – the taxCategories service
taxRates craft\commerce\services\TaxRates – the taxRates service
taxZones craft\commerce\services\TaxZones – the taxZones service
transactions craft\commerce\services\Transactions – the transactions service
variants craft\commerce\services\Variants – the variants service

# cart

Type
craft\commerce\services\Carts
Default value
null

the cart service

View source (opens new window)

# currencies

Type
craft\commerce\services\Currencies
Default value
null

the currencies service

View source (opens new window)

# customers

Type
craft\commerce\services\Customers
Default value
null

the customers service

View source (opens new window)

# discounts

Type
craft\commerce\services\Discounts
Default value
null

the discounts service

View source (opens new window)

# emails

Type
craft\commerce\services\Emails
Default value
null

the emails service

View source (opens new window)

# gateways

Type
craft\commerce\services\Gateways
Default value
null

the gateways service

View source (opens new window)

# lineItems

Type
craft\commerce\services\LineItems
Default value
null

the line items service

View source (opens new window)

# orderAdjustments

Type
craft\commerce\services\OrderAdjustments
Default value
null

the order adjustments service

View source (opens new window)

# orderHistories

Type
craft\commerce\services\OrderHistories
Default value
null

the order histories service

View source (opens new window)

# orderNotices

Type
craft\commerce\services\OrderStatuses
Default value
null

the order notices service

View source (opens new window)

# orderStatuses

Type
craft\commerce\services\OrderStatuses
Default value
null

the orderStatuses service

View source (opens new window)

# orders

Type
craft\commerce\services\Orders
Default value
null

the orders service

View source (opens new window)

# paymentCurrencies

Type
craft\commerce\services\PaymentCurrencies
Default value
null

the paymentCurrencies service

View source (opens new window)

# paymentSources

Type
craft\commerce\services\PaymentSources
Default value
null

the payment sources service

View source (opens new window)

# payments

Type
craft\commerce\services\Payments
Default value
null

the payments service

View source (opens new window)

# pdf

Type
craft\commerce\services\Pdfs
Default value
null

the pdf service

View source (opens new window)

# plans

Type
craft\commerce\services\Plans
Default value
null

the plans service

View source (opens new window)

# productTypes

Type
craft\commerce\services\ProductTypes
Default value
null

the product types service

View source (opens new window)

# products

Type
craft\commerce\services\Products
Default value
null

the products service

View source (opens new window)

# purchasables

Type
craft\commerce\services\Purchasables
Default value
null

the purchasables service

View source (opens new window)

# sales

Type
craft\commerce\services\Sales
Default value
null

the sales service

View source (opens new window)

# shippingCategories

Type
craft\commerce\services\ShippingCategories
Default value
null

the shipping categories service

View source (opens new window)

# shippingMethods

Type
craft\commerce\services\ShippingMethods
Default value
null

the shipping methods service

View source (opens new window)

# shippingRuleCategories

Type
craft\commerce\services\ShippingRuleCategories
Default value
null

the shipping rule categories service

View source (opens new window)

# shippingRules

Type
craft\commerce\services\ShippingRules
Default value
null

the shipping rules service

View source (opens new window)

# shippingZones

Type
craft\commerce\services\ShippingZones
Default value
null

the shipping zones service

View source (opens new window)

# subscriptions

Type
craft\commerce\services\Subscriptions
Default value
null

the subscriptions service

View source (opens new window)

# taxCategories

Type
craft\commerce\services\TaxCategories
Default value
null

the taxCategories service

View source (opens new window)

# taxRates

Type
craft\commerce\services\TaxRates
Default value
null

the taxRates service

View source (opens new window)

# taxZones

Type
craft\commerce\services\TaxZones
Default value
null

the taxZones service

View source (opens new window)

# transactions

Type
craft\commerce\services\Transactions
Default value
null

the transactions service

View source (opens new window)

# variants

Type
craft\commerce\services\Variants
Default value
null

the variants service

View source (opens new window)

# Public Methods

Method Description
getCarts() Returns the cart 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
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 store 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
getVariants() Returns the variants service
getWebhooks() Returns the webhooks service

# getCarts()

Returns the cart service

View source (opens new window)

Returns

craft\commerce\services\Carts – The cart service

Throws

# getCoupons()

Returns the coupons service

View source (opens new window)

Returns

craft\commerce\services\Coupons – The countries service

Throws

# getCurrencies()

Returns the currencies service

View source (opens new window)

Returns

craft\commerce\services\Currencies – The currencies service

Throws

# getCustomers()

Returns the customers service

View source (opens new window)

Returns

craft\commerce\services\Customers – The customers service

Throws

# getDiscounts()

Returns the discounts service

View source (opens new window)

Returns

craft\commerce\services\Discounts – The discounts service

Throws

# getEmails()

Returns the emails service

View source (opens new window)

Returns

craft\commerce\services\Emails – The emails service

Throws

# getFormulas()

Since
2.2

Returns the formulas service

View source (opens new window)

Returns

craft\commerce\services\Formulas – The formulas service

Throws

# getGateways()

Returns the gateways service

View source (opens new window)

Returns

craft\commerce\services\Gateways – The gateways service

Throws

# getLineItemStatuses()

Returns the lineItems statuses service

View source (opens new window)

Returns

craft\commerce\services\LineItemStatuses – The lineItems service

Throws

# getLineItems()

Returns the lineItems service

View source (opens new window)

Returns

craft\commerce\services\LineItems – The lineItems service

Throws

# getOrderAdjustments()

Returns the orderAdjustments service

View source (opens new window)

Returns

craft\commerce\services\OrderAdjustments – The orderAdjustments service

Throws

# getOrderHistories()

Returns the orderHistories service

View source (opens new window)

Returns

craft\commerce\services\OrderHistories – The orderHistories service

Throws

# getOrderNotices()

Returns the OrderNotices service

View source (opens new window)

Returns

craft\commerce\services\OrderNotices – The OrderNotices service

Throws

# getOrderStatuses()

Returns the OrderStatuses service

View source (opens new window)

Returns

craft\commerce\services\OrderStatuses – The OrderStatuses service

Throws

# getOrders()

Returns the orders service

View source (opens new window)

Returns

craft\commerce\services\Orders – The orders service

Throws

# getPaymentCurrencies()

Returns the paymentCurrencies service

View source (opens new window)

Returns

craft\commerce\services\PaymentCurrencies – The paymentCurrencies service

Throws

# getPaymentSources()

Returns the payment sources service

View source (opens new window)

Returns

craft\commerce\services\PaymentSources – The payment sources service

Throws

# getPayments()

Returns the payments service

View source (opens new window)

Returns

craft\commerce\services\Payments – The payments service

Throws

# getPdfs()

Returns the PDFs service

View source (opens new window)

Returns

craft\commerce\services\Pdfs – The PDFs service

Throws

# getPlans()

Returns the payment sources service

View source (opens new window)

Returns

craft\commerce\services\Plans – The subscription plans service

Throws

# getProductTypes()

Returns the productTypes service

View source (opens new window)

Returns

craft\commerce\services\ProductTypes – The productTypes service

Throws

# getProducts()

Returns the products service

View source (opens new window)

Returns

craft\commerce\services\Products – The products service

Throws

# getPurchasables()

Returns the purchasables service

View source (opens new window)

Returns

craft\commerce\services\Purchasables – The purchasables service

Throws

# getSales()

Returns the sales service

View source (opens new window)

Returns

craft\commerce\services\Sales – The sales service

Throws

# getShippingCategories()

Returns the shippingCategories service

View source (opens new window)

Returns

craft\commerce\services\ShippingCategories – The shippingCategories service

Throws

# getShippingMethods()

Returns the shippingMethods service

View source (opens new window)

Returns

craft\commerce\services\ShippingMethods – The shippingMethods service

Throws

# getShippingRuleCategories()

Returns the shippingRules service

View source (opens new window)

Returns

craft\commerce\services\ShippingRuleCategories – The shippingRuleCategories service

Throws

# getShippingRules()

Returns the shippingRules service

View source (opens new window)

Returns

craft\commerce\services\ShippingRules – The shippingRules service

Throws

# getShippingZones()

Returns the shippingZones service

View source (opens new window)

Returns

craft\commerce\services\ShippingZones – The shippingZones service

Throws

# getStore()

Returns the store service

View source (opens new window)

Returns

craft\commerce\services\Store – The store service

Throws

# getSubscriptions()

Returns the subscriptions service

View source (opens new window)

Returns

craft\commerce\services\Subscriptions – The subscriptions service

Throws

# getTaxCategories()

Returns the taxCategories service

View source (opens new window)

Returns

craft\commerce\services\TaxCategories – The taxCategories service

Throws

# getTaxRates()

Returns the taxRates service

View source (opens new window)

Returns

craft\commerce\services\TaxRates – The taxRates service

Throws

# getTaxZones()

Returns the taxZones service

View source (opens new window)

Returns

craft\commerce\services\TaxZones – The taxZones service

Throws

# getTaxes()

Returns the taxes service

View source (opens new window)

Returns

craft\commerce\services\Taxes – The taxes service

Throws

# getTransactions()

Returns the transactions service

View source (opens new window)

Returns

craft\commerce\services\Transactions – The transactions service

Throws

# getVariants()

Returns the variants service

View source (opens new window)

Returns

craft\commerce\services\Variants – The variants service

Throws

# getWebhooks()

Since
3.1.9

Returns the webhooks service

View source (opens new window)

Returns

craft\commerce\services\Webhooks – The variants service

Throws