Blog

For each entity we will present: the module that provides it, the class that defines it, and the available properties. For each property we will list its name, field type, a description, and a note if the field allows unlimited values (i.e. it has an unlimited cardinality). The list of properties available for a content entity depend on many factors. For example, if the entity is revisionable (e.g. revision_default), translatable (e.g. langcode), or both (e.g. revision_translation_affected). The modules that are enabled on the site can also affect the available properties. For instance, if the “Workspaces” module is installed, it will add a workspace property to many content entities. This reference assumes that Drupal was installed using the standard installation profile and only Drupal Commerce related modules that provide content entities are enabled.

It is worth noting that entity properties are divided in two categories: base field definitions and field storage configurations. Base field configurations will always be available for the entity. On the other hand, the presence of field storage configurations will depend on various factors. For one, they can only be added to fieldable entities. Attaching the fields to the entity can be done manually by the user, by a module, or by an installation profile. Again, this reference assumes that Drupal was installed using the standard installation profile with Drupal Commerce related modules enabled. By default, the commerce_product entity adds a bodyfield. For entities that can have multiple bundles, not all properties provided by the field storage configurations will be available in all bundles. For example, with the standard installation profile all content types will have a body field associated with it, but only the article content type has the field_image, and field_tags fields. If subfields are available for the field type, you can migrate into them.

If you are migrating into Drupal Commerce, make sure to check the Commerce Migrate module. It offers migrate destination field handlers for commerce fields and a plugin for commerce product types. It also provides a migration path from Commerce 1 (Drupal 7), Ubercart, and other e-commerce platforms. It is even possible to import data from other platforms like WooCommerce, Magento, and Shopify via CSV exports.

Store entity

Module: Commerce Store (part of commerce module)
Class: Drupal\commerce_store\Entity\Store

List of base field definitions:

1. store_id: (integer) ID.
2. uuid: (uuid) UUID.
3. langcode: (language) Language.
4. type: (entity_reference to commerce_store_type) Type. The store type.
5. uid: (entity_reference to user) Owner. The store owner.
6. name: (string) Name. The store name.
7. mail: (email) Email. Store email notifications are sent from this address.
8. default_currency: (entity_reference to commerce_currency) Default currency. The default currency of the store.
9. timezone: (list_string) Timezone. Used when determining promotion and tax availability.
10. address: (address) Address. The store address.
11. billing_countries: (list_string) Supported billing countries. Allows unlimited values.
12. path: (path) URL alias. The store URL alias.
13. is_default: (boolean) Default. Whether this is the default store.
14. default_langcode: (boolean) Default translation. A flag indicating whether this is the default translation.
15. shipping_countries: (list_string) Supported shipping countries. Allows unlimited values.
16. prices_include_tax: (boolean) Prices are entered with taxes included.
17. tax_registrations: (list_string) Tax registrations. The countries where the store is additionally registered to collect taxes. Allows unlimited values.

Product entity

Module: Commerce Product (part of commerce module)
Class: Drupal\commerce_product\Entity\Product

List of base field definitions:

1. product_id: (integer) ID.
2. uuid: (uuid) UUID.
3. langcode: (language) Language.
4. type: (entity_reference to commerce_product_type) Product type.
5. status: (boolean) Published.
6. stores: (entity_reference to commerce_store) Stores. The product stores. Allows unlimited values.
7. uid: (entity_reference to user) Author. The product author.
8. title: (string) Title. The product title.
9. variations: (entity_reference to commerce_product_variation) Variations. The product variations. Allows unlimited values.
10. created: (created) Created. The time when the product was created.
11. changed: (changed) Changed. The time when the product was last edited.
12. default_langcode: (boolean) Default translation. A flag indicating whether this is the default translation.

List of field storage configurations:

1. body: text_with_summary field.

Product variation entity

Module: Commerce Product (part of commerce module)
Class: Drupal\commerce_product\Entity\ProductVariation

List of base field definitions:

1. variation_id: (integer) ID.
2. uuid: (uuid) UUID.
3. langcode: (language) Language.
4. type: (entity_reference to commerce_product_variation_type) Product variation type.
5. status: (boolean) Published.
6. uid: (entity_reference to user) Author. The variation author.
7. product_id: (entity_reference to commerce_product) Product. The parent product.
8. sku: (string) SKU. The unique, machine-readable identifier for a variation.
9. title: (string) Title. The variation title.
10. list_price: (commerce_price) List price. The list price.
11. price: (commerce_price) Price. The price
12. created: (created) Created. The time when the variation was created.
13. changed: (changed) Changed. The time when the variation was last edited.
14. default_langcode: (boolean) Default translation. A flag indicating whether this is the default translation.

Product attribute value entity

Module: Commerce Product (part of commerce module)
Class: Drupal\commerce_product\Entity\ProductAttributeValue

List of base field definitions:

1. attribute_value_id: (integer) ID.
2. uuid: (uuid) UUID.
3. langcode: (language) Language.
4. attribute: (entity_reference to commerce_product_attribute) Attribute.
5. name: (string) Name. The attribute value name.
6. weight: (integer) Weight. The weight of this attribute value in relation to others.
7. created: (created) Created. The time when the attribute value was created.
8. changed: (changed) Changed. The time when the attribute value was last edited.
9. default_langcode: (boolean) Default translation. A flag indicating whether this is the default translation.

Order entity

Module: Commerce Order (part of commerce module)
Class: Drupal\commerce_order\Entity\Order

List of base field definitions:

1. order_id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (entity_reference to commerce_order_type) Order type.
4. order_number: (string) Order number. The order number displayed to the customer.
5. store_id: (entity_reference to commerce_store) Store. The store to which the order belongs.
6. uid: (entity_reference to user) Customer. The customer.
7. mail: (email) Contact email. The email address associated with the order.
8. ip_address: (string) IP address. The IP address of the order.
9. billing_profile: (entity_reference_revisions) Billing information. Billing profile
10. order_items: (entity_reference to commerce_order_item) Order items. The order items. Allows unlimited values.
11. adjustments: (commerce_adjustment) Adjustments. Allows unlimited values.
12. total_price: (commerce_price) Total price. The total price of the order.
13. total_paid: (commerce_price) Total paid. The total paid price of the order.
14. state: (state) State. The order state.
15. data: (map) Data. A serialized array of additional data.
16. locked: (boolean) Locked.
17. created: (created) Created. The time when the order was created.
18. changed: (changed) Changed. The time when the order was last edited.
19. placed: (timestamp) Placed. The time when the order was placed.
20. completed: (timestamp) Completed. The time when the order was completed.
21. cart: (boolean) Cart.
22. checkout_flow: (entity_reference to commerce_checkout_flow) Checkout flow.
23. checkout_step: (string) Checkout step.
24. payment_gateway: (entity_reference to commerce_payment_gateway) Payment gateway. The payment gateway.
25. payment_method: (entity_reference to commerce_payment_method) Payment method. The payment method.
26. coupons: (entity_reference to commerce_promotion_coupon) Coupons. Coupons that have been applied to order. Allows unlimited values.

Order item entity

Module: Commerce Order (part of commerce module)
Class: Drupal\commerce_order\Entity\OrderItem

List of base field definitions:

1. order_item_id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (entity_reference to commerce_order_item_type) Order item type.
4. order_id: (entity_reference to commerce_order) Order. The parent order.
5. purchased_entity: (entity_reference to node) Purchased entity. The purchased entity.
6. title: (string) Title. The order item title.
7. quantity: (decimal) Quantity. The number of purchased units.
8. unit_price: (commerce_price) Unit price. The price of a single unit.
9. overridden_unit_price: (boolean) Overridden unit price. Whether the unit price is overridden.
10. total_price: (commerce_price) Total price. The total price of the order item.
11. adjustments: (commerce_adjustment) Adjustments. Allows unlimited values.
12. uses_legacy_adjustments: (boolean) Uses legacy adjustments.
13. data: (map) Data. A serialized array of additional data.
14. created: (created) Created. The time when the order item was created.
15. changed: (changed) Changed. The time when the order item was last edited.

Payment method entity

Module: Commerce Payment (part of commerce module)
Class: Drupal\commerce_payment\Entity\PaymentMethod

List of base field definitions:

1. method_id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (string) Payment method type.
4. payment_gateway: (entity_reference to commerce_payment_gateway) Payment gateway. The payment gateway.
5. payment_gateway_mode: (string) Payment gateway mode. The payment gateway mode.
6. uid: (entity_reference to user) Owner. The payment method owner.
7. remote_id: (string) Remote ID. The payment method remote ID.
8. billing_profile: (entity_reference_revisions) Billing profile. Billing profile
9. reusable: (boolean) Reusable. Whether the payment method is reusable.
10. is_default: (boolean) Default. Whether this is the user's default payment method.
11. expires: (timestamp) Expires. The time when the payment method expires. 0 for never.
12. created: (created) Created. The time when the payment method was created.
13. changed: (changed) Changed. The time when the payment method was last edited.

Payment entity

Module: Commerce Payment (part of commerce module)
Class: Drupal\commerce_payment\Entity\Payment

List of base field definitions:

1. payment_id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (string) Payment type.
4. payment_gateway: (entity_reference to commerce_payment_gateway) Payment gateway. The payment gateway.
5. payment_gateway_mode: (string) Payment gateway mode. The payment gateway mode.
6. payment_method: (entity_reference to commerce_payment_method) Payment method. The payment method.
7. order_id: (entity_reference to commerce_order) Order. The parent order.
8. remote_id: (string) Remote ID. The remote payment ID.
9. remote_state: (string) Remote State. The remote payment state.
10. amount: (commerce_price) Amount. The payment amount.
11. refunded_amount: (commerce_price) Refunded amount. The refunded payment amount.
12. state: (state) State. The payment state.
13. authorized: (timestamp) Authorized. The time when the payment was authorized.
14. expires: (timestamp) Expires. The time when the payment expires. 0 for never.
15. completed: (timestamp) Completed. The time when the payment was completed.
16. test: (boolean) Test. Whether this is a test payment.
17. captured: (timestamp) Captured. The time when the payment was captured.

Promotion entity

Module: Commerce Promotion (part of commerce module)
Class: Drupal\commerce_promotion\Entity\Promotion

List of base field definitions:

1. promotion_id: (integer) ID.
2. uuid: (uuid) UUID.
3. langcode: (language) Language.
4. name: (string) Name. The promotion name.
5. display_name: (string) Display name. If provided, shown on the order instead of "Discount".
6. description: (string_long) Description. Additional information about the promotion to show to the customer
7. order_types: (entity_reference to commerce_order_type) Order types. The order types for which the promotion is valid. Allows unlimited values.
8. stores: (entity_reference to commerce_store) Stores. The stores for which the promotion is valid. Allows unlimited values.
9. offer: (commerce_plugin_item:commerce_promotion_offer) Offer type.
10. conditions: (commerce_plugin_item:commerce_condition) Conditions. Allows unlimited values.
11. condition_operator: (list_string) Condition operator. The condition operator.
12. coupons: (entity_reference to commerce_promotion_coupon) Coupons. Coupons which allow promotion to be redeemed. Allows unlimited values.
13. usage_limit: (integer) Usage limit. The maximum number of times the promotion can be used. 0 for unlimited.
14. start_date: (datetime) Start date. The date the promotion becomes valid.
15. end_date: (datetime) End date. The date after which the promotion is invalid.
16. compatibility: (list_string) Compatibility with other promotions.
17. status: (boolean) Status. Whether the promotion is enabled.
18. weight: (integer) Weight. The weight of this promotion in relation to others.
19. default_langcode: (boolean) Default translation. A flag indicating whether this is the default translation.

Coupon entity

Module: Commerce Promotion (part of commerce module)
Class: Drupal\commerce_promotion\Entity\Coupon

List of base field definitions:

1. id: (integer) ID.
2. uuid: (uuid) UUID.
3. promotion_id: (entity_reference to commerce_promotion) Promotion. The parent promotion.
4. code: (string) Coupon code. The unique, machine-readable identifier for a coupon.
5. usage_limit: (integer) Usage limit. The maximum number of times the coupon can be used. 0 for unlimited.
6. status: (boolean) Status. Whether the coupon is enabled.

Log entity

Module: Commerce Log (part of commerce module)
Class: Drupal\commerce_log\Entity\Log

List of base field definitions:

1. log_id: (integer) ID.
2. uuid: (uuid) UUID.
3. uid: (entity_reference to user) User. The user for the log.
4. template_id: (string) Log template ID. The log template plugin ID
5. category_id: (string) Log category ID. The log category plugin ID
6. source_entity_id: (integer) Source entity ID. The source entity ID
7. source_entity_type: (string) Source entity type. The source entity type
8. params: (map) Params. A serialized array of parameters for the log template.
9. created: (created) Created. The time when the log was created.

Price list entity

Module: Commerce Pricelist
Class: Drupal\commerce_pricelist\Entity\PriceList

List of base field definitions:

1. id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (string) Price list bundle.
4. uid: (entity_reference to user) Owner. The user that owns this price list.
5. name: (string) Name. The name of the price list.
6. stores: (entity_reference to commerce_store) Stores. The stores for which the price list is valid. Allows unlimited values.
7. customer: (entity_reference to user) Customer. The customer for which the price list is valid.
8. customer_roles: (entity_reference to user_role) Customer roles. The customer roles for which the price list is valid. Allows unlimited values.
9. start_date: (datetime) Start date. The date the price list becomes valid.
10. end_date: (datetime) End date. The date after which the price list is invalid.
11. weight: (integer) Weight. The weight of this price list in relation to other price lists.
12. status: (boolean) Status. Whether the price list is enabled.
13. changed: (changed) Changed. The time when the price list was last edited.

Price list item entity

Module: Commerce Pricelist
Class: Drupal\commerce_pricelist\Entity\PriceListItem

List of base field definitions:

1. id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (string) Price list item bundle.
4. uid: (entity_reference to user) Owner. The user that owns this price list item.
5. price_list_id: (entity_reference to commerce_pricelist) Price list. The parent price list.
6. purchasable_entity: (entity_reference to commerce_product_variation) Purchasable entity. The purchasable entity.
7. quantity: (decimal) Quantity. The quantity tier.
8. list_price: (commerce_price) List price. The list price.
9. price: (commerce_price) Price. The price.
10. status: (boolean) Status. Whether the price list item is enabled.
11. changed: (changed) Changed. The time when the price list item was last edited.

Shipment entity

Module: Shipping
Class: Drupal\commerce_shipping\Entity\Shipment

List of base field definitions:

1. shipment_id: (integer) ID.
2. uuid: (uuid) UUID.
3. type: (entity_reference to commerce_shipment_type) Shipment type.
4. order_id: (entity_reference to commerce_order) Order. The parent order.
5. package_type: (string) Package type. The package type.
6. shipping_method: (entity_reference to commerce_shipping_method) Shipping method. The shipping method
7. shipping_service: (string) Shipping service. The shipping service.
8. shipping_profile: (entity_reference_revisions) Shipping information.
9. title: (string) Title. The shipment title.
10. items: (commerce_shipment_item) Items. Allows unlimited values.
11. weight: (physical_measurement) Weight.
12. original_amount: (commerce_price) Original amount. The original amount.
13. amount: (commerce_price) Amount. The amount.
14. adjustments: (commerce_adjustment) Adjustments. Allows unlimited values.
15. tracking_code: (string) Tracking code. The shipment tracking code.
16. state: (state) State. The shipment state.
17. data: (map) Data. A serialized array of additional data.
18. created: (created) Created. The time when the shipment was created.
19. changed: (changed) Changed. The time when the shipment was last updated.
20. shipped: (timestamp) Shipped. The time when the shipment was shipped.

Shipping method entity

Module: Shipping
Class: Drupal\commerce_shipping\Entity\ShippingMethod

List of base field definitions:

1. shipping_method_id: (integer) ID.
2. uuid: (uuid) UUID.
3. langcode: (language) Language.
4. stores: (entity_reference to commerce_store) Stores. The stores for which the shipping method is valid. Allows unlimited values.
5. plugin: (commerce_plugin_item:commerce_shipping_method) Plugin.
6. name: (string) Name. The shipping method name.
7. conditions: (commerce_plugin_item:commerce_condition) Conditions. Allows unlimited values.
8. condition_operator: (list_string) Condition operator. The condition operator.
9. weight: (integer) Weight. The weight of this shipping method in relation to others.
10. status: (boolean) Enabled. Whether the shipping method is enabled.
11. default_langcode: (boolean) Default translation. A flag indicating whether this is the default translation.

Available properties for other content entities

This reference includes Drupal Commerce content entities and some provided by related contributed modules. The previous article included a reference for Drupal core content entities. That being said, it would be impractical to cover all contributed modules. To get a list of yourself for other content entities, load the entity_type.manager service and call its getFieldStorageDefinitions() method passing the machine name of the entity as a parameter. Although this reference only covers content entities, the same process can be used for configuration entities.

What did you learn in today’s article? Did you know that there were so many entity properties provided by Drupal Commerce? Were you aware that the list of available properties depend on factors like if the entity is fieldable, translatable, and revisionable? Did you know how to find properties for content entities from contributed modules? Please share your answers in the comments. Also, we would be grateful if you shared this article with your friends and colleagues.