E-mail Templates
In the Akinon Commerce platform, email templates play a crucial role in maintaining consistent and effective communication with users. These templates are pre-defined email formats used to send automated messages to users based on specific triggers or actions within the platform. This document provides a comprehensive overview of managing email templates, including their loading process, creation, and updating via the Omnitron panel. Additionally, it details the various types of email templates available, their usage, and the context variables associated with each template.
Managing Email Templates
The default email templates are loaded in projects deployed via ACC. This loader checks for the existence of email templates in the following order:
Database:
The loader first checks if the email template exists in the database.
If the template is found in the database, it is used for sending emails.
File System:
If the template is not found in the database, the loader then checks the file system for the template.
The file path for the template is used if it is not present in the database.
Creating and Updating Mail Templates
Mail templates can be created and managed through the Omnitron panel (Sales Channels > Content Management > Mailing Templates). This interface allows for the management of mail templates used across various sales channels.
Send Emails in Different Languages
When users interact with your site in a language other than the default—such as Arabic—they should receive all system-generated emails (e.g., order confirmation, welcome emails, password reset emails) in the same language. However, if the multilingual configuration is incomplete, emails may still be sent in the default language (e.g., English), regardless of the language used on the site.
To ensure emails are sent in the appropriate language:
Define Supported Languages in Project Settings During project setup, all supported languages and locales must be defined. Follow the Language and Locale Setup Guide and make sure any additional languages (e.g., Arabic) are added correctly.
Create Language-Specific Email Templates in Omnitron The languages defined in the project become available as options in the Language dropdown when creating or editing email templates in Omnitron > Sales Channels > Content Management > Mailing Templates.
Enter the Corresponding Content Per Language For each email type (order, reset password, welcome, etc.), select the desired "Language" from the dropdown and provide the content in that language. This ensures that users always receive localized email content matching their on-site experience.
Detailed steps for creating and updating mail templates can be found in the Mailing Templates documentation.
All Existing Email Templates
1. Contact Us
This is a communication email template that allows users to reach out to the brand. Users can select from predefined subjects relevant to their inquiry.
Template Path:
Context Variables:
subject: The subject line of the email, chosen by the user from a list of predefined subjects set by the brand.
full_name: The full name of the user who is sending the email.
email: The email address of the user.
message: The main body of the user's message.
phone: The user's phone number.
file: Any file uploaded by the user. This can include documents, images, or any relevant files that support the user's message.
order: An object representing the user's order details. The details of the order object are provided in the Order table.
operation: The mail group category defined in the module.
site_domain: The domain of the website from which the email is sent.
2. Password Reset
A password reset email is sent by the commerce platform when a user requests to reset their password. The email facilitates the process by providing a link or instructions for resetting the password.
Template Path:
There is no existing template; it needs to be entered manually into the RESET_EMAIL_HTML_TEMPLATE dynamic setting in Omnitron.
Context Variables:
email: The email address to which the password reset email will be sent. This is the user's registered email address used for receiving the reset instructions.
3. Post Order Discount
This email is sent to notify the user about discounts earned after placing an order. The email informs the user about any applicable post-order coupons or discounts.
Template Path:
When creating a campaign in Omnitron with the action type set to "Coupon", a path is generated in the format emails/promotions/{template_prefix}. This path uses the {template_prefix} value entered in the "Email Templates" parameter of the coupon information field. Based on the entered {template_prefix}, a path will be automatically generated.
Example: If you enter summer_sale as the template prefix, the generated path will be emails/promotions/summer_sale.
Context Variables:
basket_offer: The
BasketOfferobject related to the post-order discount. This object contains details about the discount or promotion applied to the user's order. The details of the basket_offer object are provided below.basket_offer.label
basket_offer.promotion.name
site_domain: The domain of the website where the order was placed.
user: The
Userobject representing the user who placed the order. This object contains the user's information necessary for personalization and addressing the email. The details of the user object are provided in the User table.
4. Email Verification
An email verification message is sent to users to verify their email address during the registration process. However, this behavior can be disabled by configuring the ACCOUNT_EMAIL_VERIFICATION setting in the Commerce environment of ACC.
Setting ACCOUNT_EMAIL_VERIFICATION = 'none' disables automatic email verification during registration.
Template Path:
Context Variables:
user: The
Userobject representing the new user who is registering. This object contains the user's information necessary for personalization and addressing the email. The details of the user object are provided in the User table.activate_url: The URL provided for email verification. This link redirects the user to a page where they can verify their email address.Example URL: https://akinon.akinon.net/users/registration/account-confirm-email/{confirmation_key}/
current_site: The domain of the verification website.
key: The confirmation key used to authenticate the user's email address. This key is also included within the above activate_url. There is no expiration period for this key.
5. Loyalty Money Refund
A notification email sent when loyalty money used in an order is refunded.
Template Path:
Context Variables:
user: The
Userobject representing the user who is receiving the refund. The details of the user object are provided in the User table.loyalty_money_amount: The amount of loyalty money that is being refunded.
currency: The currency in which the refunded amount is issued.
order_number: The number associated with the order for which the loyalty money is being refunded.
order_language_code: The language code of the order.
6. Order Received
A notification email sent to users when an order is successfully placed. This email is automatically sent during the order creation process.
Template Path:
Context Variables:
order: The
Orderobject representing the details of the placed order. The details of the order object are provided in the Order table.site_domain: The domain of the website where the order was placed.
7. Order Shipped
A notification email sent to users when their order has been shipped. This email is triggered when the order status changes to 'shipped = 500'.
Template Path:
Context Variables:
order: The
Orderobject representing the details of the shipped order. The details of the order object are provided in the Order table.site_domain: The domain of the website where the order was placed.
8. Partially Shipped Order
A notification email sent when some items in an order are shipped.
Template Path:
Context Variables:
order: The
Orderobject representing the details of the order. The details of the order object are provided in the Order table.order_items: The
OrderItemobjects that have been shipped. This includes information about the items that are on their way to the customer. The details of the order_items object are provided in the Order_item table.shipping_company: The name of the shipping company handling the shipment. This helps the customer know which carrier is delivering their items.
tracking_number: The tracking number provided by the shipping company. This allows the customer to track the shipment of the partially shipped items.
site_domain: The domain of the website where the order was placed.
remaining_orderitems: All
OrderItemobjects that have not entered the cancellation process—specifically, items whose status is notcancelledorcancellation_waiting. This means the items listed here may be pending shipment, in transit, or even already delivered. The structure is the same as theorder_itemsobject.
9. Order Delivered
A notification email sent to users when their order is delivered.
Template Path:
Context Variables:
order: The
Orderobject representing the details of the delivered order. The details of the order object are provided in the Order table.site_domain: The domain of the website where the order was placed.
return_address: The return address provided in the settings. Enter this into the
ORDER_RETURN_ADDRESSfield in the Django settings, with the string type.
10. Partially Delivered Order
A notification email sent when some items in an order are delivered.
Template Path:
Context Variables:
order: The
Orderobject representing the details of the order. The details of the order object are provided in the Order table.order_items: The
OrderItemobjects that have been delivered. This includes information about the items that have reached the customer. The details of the order_items object are provided in the Order_item table.shipping_company: he name of the shipping company handling the delivery. This helps the customer know which carrier has delivered their items.
tracking_number: The tracking number provided by the shipping company. This allows the customer to track the delivery of the partially delivered items.
site_domain: The domain of the website where the order was placed.
11. Order Ready for Pickup
A notification email sent to users when their order is ready for pickup. This email, triggered when the order arrives at the store, provides information about the pickup process. It simply informs users that their order is ready and provides details on how to collect it.
Template Path:
Context Variables:
order: The
Orderobject representing the details of the order. The details of the order object are provided in the Order table.site_domain: The domain of the website where the order was placed.
return_address: The return address provided in the settings.
12. Package Created in OMS
An email sent to relevant stock locations when a package is prepared or created in the Order Management System (OMS).
Template Paths:
package.created:
For mail body:
emails/orders/package-created.html(This template is used for the body of the email that is sent when a package is created.)For mail subject:
emails/orders/package-created-subject.html(This template is used for the subject line of the email that is sent when a package is created.)
package.status.preparing:
For mail body:
emails/orders/offer-accepted.html(This template is used for the body of the email that is sent when an offer is accepted.)For mail subject:
emails/orders/offer-accepted-subject.html(This template is used for the subject line of the email that is sent when an offer is accepted.)
Context Variables:
The payload from the OMS request is directly used as the context. The specific details of the payload are not included due to size, but they typically include information about the package, order details, and relevant stock location data.
Example Payload:
13. Checkout URL
An email sent to users containing the checkout URL. This email provides the user with a direct link to complete their purchase. The user can either scan a QR code in-store or receive the link via SMS, both of which direct them to the checkout page where they can proceed with their payment.
Template Path:
Context Variables:
user: The
Userobject representing the user who will receive the checkout URL. The details of the user object are provided in the User table.checkout_url: The URL where the user can complete their purchase.
site_domain: The domain of the website where the order was initiated.
14. Order Cancellation/Return Request
An information email sent to users when they request to cancel or return an order.
Template Paths:
refund:
emails/orders/refund-request.htmlcancel:
emails/orders/cancel-request.htmleasy return:
emails/orders/easy-refund-request.html
Context Variables:
default:
order: The
Orderobject representing the order that is being canceled or returned. The details of the order object are provided in the Order table.site_domain: The domain of the website where the order was placed.
easy return:
return_code: The code assigned to the return request.
order_items: The
OrderItemobjects that are being returned via the easy return process.The details of the order_items object are provided in the Order_item table.
15. Product Back in Stock
A notification email sent to users when a product that was previously out of stock is back in stock. However, it is important to note that no email is triggered for extra stock of the same product once the initial notification has been sent.
Template Path:
Context Variables:
product: The
Productobject that is back in stock. The details of the user object are provided in the Product table.site_domain: The domain of the website where the product is listed.
user: The
Userobject representing the user who is receiving the notification. The details of the user object are provided in the User table.
16. Price Drop Alert
A notification email sent to users when the price of a product drops below a certain threshold. This email was not triggered for the extra product stock and extra product price lists.
Template Path:
Context Variables:
product: The
Productobject with the price drop. The details of the user object are provided in the Product table.site_domain: The domain of the website where the product is listed.
user: The
Userobject representing the user who is receiving the notification. The details of the user object are provided in the User table.
17. Verification Code
An email sent to the user for activation purposes. After the initial automated activation email is sent (detailed in the 4. Email Verification section), a manual activation email can be resent through Omnitron. This is done by clicking the highlighted button on the User Detail Page in Omnitron.
Template Path:
Context Variables:
verification_code: The code sent to the user for verification. This code is used to verify the user's identity or action and is typically a one-time password (OTP).
18. Membership Welcome Email
A welcome email sent to the user when they register. This email is sent by the allauth package.
Template Path:
Context Variables:
user: The
Userobject representing the new user who has registered. The details of the user object are provided in the User table.activate_url: The email verification link that the user must click to verify their email address and activate their account.
current_site: The domain of the verification site.
key: The verification key used to validate the email verification link.
19. InStore Order Notification
A notification email sent to the store staff member when an InStore order is successfully placed. The recipient is the staff member who initiated the order, identified via the HTTP_X_STORE_STAFF_EMAIL request header. This email is only sent when order.client_type is instore and a staff email address is present in order.extra_field['instore_data']['staff_email'].
The email is dispatched asynchronously via a Celery task (send_instore_order_email) through OrderTaskService, so a failure in sending does not affect order creation.
Template Paths:
For mail body:
emails/orders/instore-order-completed.htmlFor mail subject:
emails/orders/instore-order-completed-subject.html
Fallback subject (used when the subject template renders empty): "New InStore order: <order.number>"
Context Variables:
order: The
Orderobject representing the details of the placed InStore order. The details of the order object are provided in the Order table.product_types: The
ProductTypesenum, available for use in template conditionals.site_domain: The domain of the website where the order was placed.
Disabling the template:
This template follows the same DISABLED_EMAIL_TEMPLATES dynamic setting mechanism as other order emails:
20. Question Answered (Conversation Reply)
A notification email sent to the user when the brand/seller replies to a question the user submitted through the Contact Us template.
Template Paths:
For mail body:
emails/users/conversation-replied.htmlFor mail subject:
emails/users/conversation-replied-subject.html
Context Variables:
conversation: The conversation object containing the original question and the reply. Includes the question
subject,message, and the reply content.user: The
Userobject representing the user who asked the question and is receiving the reply. The details of the user object are provided in the User table.site_domain: The domain of the website where the question was submitted.
Disabling the template:
This template follows the same DISABLED_EMAIL_TEMPLATES dynamic setting mechanism as other emails:
21. Order Preparing
An email sent to the user when their order transitions to the preparing (450) status.
Template Paths:
For mail body:
emails/orders/preparing.htmlFor mail subject:
emails/orders/preparing-subject.html
Fallback subject (used when the subject template renders empty): "Your order <order.number> is being prepared."
Context Variables:
order: The
Orderobject representing the order being prepared.site_domain: The domain of the website where the order was placed.
Enabling the template:
This email is disabled by default for all brands. To enable it, set the corresponding key to False in DISABLED_EMAIL_TEMPLATES:
22. Email Change Notice to Old Address
A message sent to the customer's previous email address once their email address has been changed, containing a one-click link that undoes the change. It is the recovery path for a customer whose account was taken over: the message deliberately goes to the address that was taken away from them.
Sent only when the confirmation link is routed to its protected variant through the EMAIL_SET_PRIMARY_VIEW environment variable (entry 95 of Environment Variables). See How to Configure Step-Up Verification for the flow this message belongs to, and the SECURE_EMAIL_CHANGE_REVOKE_WINDOW_DAYS entry in Dynamic Settings for how long its link stays valid.
Template Paths:
For mail body:
account/email/email_change_old_notice.htmlFor mail subject:
account/email/email_change_old_notice_subject.html
Fallback subject (used when the subject template does not exist): "Your email address was changed | <site_name>"
Context Variables:
user: The
Userobject whose email address was changed. The details of the user object are provided in the User table.old_email: The previous email address — the recipient of this message.
new_email: The new address that has just become the account's email.
revoke_url: The absolute one-click link that undoes the change. Valid for
SECURE_EMAIL_CHANGE_REVOKE_WINDOW_DAYSdays and usable only once.site_domain: The domain of the website.
site_name: The name of the website.
Disabling the template:
This template follows the same DISABLED_EMAIL_TEMPLATES dynamic setting mechanism as the order emails:
Place revoke_url prominently. Disabling this message does not disable the ability to undo a change — it only stops telling the customer about it, which leaves them with nothing to click if the change was not theirs.
23. Email Change Revoked Notice
A confirmation sent to the restored email address after a change has been undone through the link above.
Undoing a change also makes the account's current password unusable and starts the normal password reset flow, so this message should tell the customer both things: that the change was reversed, and that their password was disabled with a reset link on its way. The reset link itself is sent separately, using the project's existing password reset templates (see 2. Password Reset).
Template Paths:
For mail body:
account/email/email_change_revoked_notice.htmlFor mail subject:
account/email/email_change_revoked_notice_subject.html
Fallback subject (used when the subject template does not exist): "Your email address change was revoked | <site_name>"
Context Variables:
user: The
Userobject whose email change was undone.old_email: The restored email address — the recipient of this message.
new_email: The address that had been set and has now been removed.
site_domain: The domain of the website.
site_name: The name of the website.
Disabling the template:
SMS Templates for Account Changes
A phone number change has no confirmation step — the new number takes effect as soon as it is accepted — so the equivalent messages are sent by text message to the customer's previous number. These templates are resolved the same way as email templates (database first, then the file system) and are managed in the same Omnitron screen.
Both are sent only while the phone-change purpose is enabled in the VERIFICATION_TOKEN_CONF dynamic setting; the messages ride on the same switch as the identity check itself. See How to Configure Step-Up Verification for the flow, and the SECURE_PHONE_CHANGE_REVOKE_WINDOW_DAYS entry in Dynamic Settings for how long the undo link stays valid. They are delivered through the configured SMS gateway and fail quietly, so a gateway problem never blocks the customer's profile update.
1. Phone Change Notice to Old Number
Sent to the previous number once the change is applied, carrying the one-click link that undoes it.
Template Path:
Context Variables:
old_phone: The previous phone number — the recipient of this message.
new_phone: The new number, masked (first four and last two digits only). The full new number is deliberately not included.
revoke_url: The absolute one-click link that undoes the change. Valid for
SECURE_PHONE_CHANGE_REVOKE_WINDOW_DAYSdays and usable only once.site_domain: The domain of the website.
site_name: The name of the website.
Keep this message short and put revoke_url early: it has to carry a link and still fit a single text message, and it is the customer's only way to undo a phone number change.
2. Phone Change Revoked Notice
Sent to the restored number after a phone number change has been undone.
As with the email equivalent, undoing a change makes the account's current password unusable and starts a password reset, so this message should say so — a customer who reads only that the change was reversed, and then finds their password rejected, has no way to connect the two.
Template Path:
Context Variables:
This template is rendered with no context variables — write it as fixed text.
3. Password Reset After an Undo
Undoing a phone number change sends the password reset link by text message, through the same service as the storefront's phone-based password reset. That message has no template of its own in this feature — it uses:
No SMS bodies are shipped with the platform, and this one is no exception: if your project does not provide sms/account/reset-password.html, the message is skipped without raising an error. The password would still have been disabled, leaving the customer with no reset link on that channel. Make sure the template exists before enabling the identity check for phone number changes.
Undoing an email change has no equivalent gap: the reset link is mailed through the platform's own password reset flow, which uses the templates documented in 2. Password Reset above.
Rules for Sending Emails on Order Status Transitions
Emails are sent to inform users about specific transitions in the order status. For these emails to be sent, the following conditions must be met. Additionally, if necessary, the corresponding dynamic settings should be configured in Omnitron > Sales Channel Settings > Dynamic Settings page.
1. Order Shipped
Rule:
SEND_SHIPPING_NOTIFICATIONS_PARTIALLYdynamic setting is set toFalse.\
The previous status of the order is either
OrderStatus.approvedorOrderStatus.preparing.The new status of the order is
OrderStatus.shipped.A tracking number is present on the order.
Email Triggered: When these conditions are met, an email notification is sent to inform the user that their order has been shipped.
2. Order Ready for Pickup
Rule:
The previous status of the order is either
OrderStatus.shippedorOrderStatus.shipped_and_informed.The new status of the order is
OrderStatus.ready_for_pickup.
Email Triggered: When these conditions are met, an email notification is sent to inform the user that their order is ready for pickup.
3. Order Delivered
Rule:
SEND_SHIPPING_DELIVERED_NOTIFICATIONS_PARTIALLYdynamic setting is set toFalse.\
The previous status of the order is either
OrderStatus.shipped,OrderStatus.shipped_and_informed, orOrderStatus.attempted_delivery.The new status of the order is
OrderStatus.delivered.
Email Triggered: When these conditions are met, an email notification is sent to inform the user that their order has been delivered.
4. Partially Shipped Order
Rule:
SEND_SHIPPING_NOTIFICATIONS_PARTIALLYdynamic setting is set toTrue.\is_status_changedisTrue(the order item's status has changed).The new status of the order item is
OrderStatus.shipped.A tracking number is present on the order item.
Email Triggered: When these conditions are met, an email notification is sent to inform the user that some items in their order have been shipped.
5. Partially Delivered Order
Rule:
SEND_SHIPPING_DELIVERED_NOTIFICATIONS_PARTIALLYdynamic setting is set toTrue.\is_status_changedisTrue(the order item's status has changed).The new status of the order item is
OrderStatus.delivered.
Email Triggered: When these conditions are met, an email notification is sent to inform the user that some items in their order have been delivered.
6. Order Preparing
Rule:
The previous status of the order is not
OrderStatus.preparing.The new status of the order is
OrderStatus.preparing.DISABLED_EMAIL_TEMPLATESdynamic setting has"emails/orders/preparing"set toFalse.
Email Triggered: When these conditions are met, an email notification is sent to inform the user that their order is being prepared.
Enabling/Disabling Emails
Verification Email
The sending of the verification email can be stopped by setting the corresponding dynamic setting to False.
Dynamic Setting:
SHOULD_SEND_VERIFICATION_EMAIL\
Description: Sent when a user signs up to verify their email address.
Other Email Templates
Most other email templates can be disabled individually via the DISABLED_EMAIL_TEMPLATES dynamic setting in Omnitron > Sales Channel Settings > Dynamic Settings. This setting is an object whose keys are template paths (the same path listed for each template above, without the file extension) and whose values are booleans; setting a template's value to true stops that email from being sent.
Not every template listed in All Existing Email Templates supports this mechanism — check the "Disabling the template" note under the relevant template entry, where present, for the exact path to use.
Triggering Emails in Local Environment
Configuring SMTP Server
To send emails through the application in a local environment, SMTP settings need to be configured. Fill in the following settings with the SMTP server information that will be used for sending emails:
Observing Emails Without SMTP Server
If the SMTP server settings are not configured, the content of sent emails will be written to the console. For example, the "Order Received" email sent to the user upon placing an order will be displayed in the console.
Identifying Email Sending Errors
Errors in the code blocks responsible for sending emails are usually caught and sent to Sentry. The errors that occur during these send operations can be reviewed in the Sentry logs of the relevant brand. For mail send operations without controlled error handling, the errors can be observed in the application logs.
Common Errors
Most errors during mail sending are related to template rendering. To reproduce and fix these errors, the relevant templates can be rendered locally.
Troubleshooting Tips
Check Sentry Logs: If your application is integrated with Sentry, check the Sentry dashboard for any errors related to email sending.
Review Application Logs: Look at the console logs for any error messages or stack traces that can provide clues.
Validate Templates: Ensure that all required context variables are being passed to the template and that the template is correctly formatted.
Test Locally: Render the email templates locally with test data to see if any errors occur.
Object Details
This section provides a detailed overview of various objects and their associated attributes within the system. The objects include Order, Address, Order_item, Product, User, DataSource, and CategoryNode. Each object contains multiple fields that define its properties and relationships with other objects. This structured information is crucial for understanding how these objects interact within the system and for implementing or maintaining related features.
Below is a table outlining the fields and their corresponding objects.
Order
Field Name
Description
order.number
The unique identifier for the order.
order.user → User
The user who placed the order.
order.user_email
The email address of the user who placed the order.
order.bin_number
The BIN (Bank Identification Number) used in the transaction.
order.installment_count
The number of installments for the payment.
order.installment_interest_amount
The interest amount for installment payments.
order.currency
The currency used for the order.
order.status
The current status of the order.
order.amount
The total amount for the order.
order.discount_amount
The total discount applied to the order.
order.shipping_amount
The shipping cost for the order.
order.shipping_refund_amount
Refunded portion of the original shipping_amount.
order.shipping_interest_amount
Interest amount calculated specifically for the shipping amount when included in an installment payment plan.
order.net_shipping_amount
Final shipping amount charged after deducting any shipping discounts or campaign reductions from shipping_amount.
order.shipping_tracking_url
The URL for tracking the shipment.
order.shipping_tax_rate
The tax rate applied to the shipping amount.
order.shipping_company
The company responsible for shipping the order.
order.shipping_option.name
The name of the selected shipping option.
order.shipping_option.logo
The logo of the shipping option provider.
order.shipping_address → Address
The shipping address associated with the order.
order.billing_address → Address
The billing address associated with the order.
order.refund_amount
The amount refunded for the order.
order.discount_refund_amount
The amount refunded from the discount.
order.invoice_number
The invoice number associated with the order.
order.invoice_date
The date when the invoice was issued.
order.e_archive_url
The URL to the electronic archive of the invoice.
order.tracking_number
The tracking number for the shipment.
order.gift_box_note
The note included in the gift box.
order.client_type
The type of client.
order.language_code
The language code for the order.
order.notes
Additional notes related to the order.
order.orderitem_set → OrderItem[]
A list of items included in the order.
Order_item
Field Name
Description
order.orderitem_set[0].product → Product
The product associated with the order item.
order.orderitem_set[0].shipping_tracking_url
The URL for tracking the shipment of the item.
order.orderitem_set[0].datasource → DataSource
The seller for the product.
order.orderitem_set[0].status
The status of the order item.
order.orderitem_set[0].price_currency
The currency used for the item's price.
order.orderitem_set[0].price
The price of the order item.
order.orderitem_set[0].tax_rate
The tax rate applied to the item.
order.orderitem_set[0].invoice_number
The invoice number for the item.
order.orderitem_set[0].invoice_date
The invoice date for the item.
order.orderitem_set[0].e_archive_url
The URL to the electronic archive of the invoice for the item.
order.orderitem_set[0].tracking_number
The tracking number for the item shipment.
order.orderitem_set[0].retail_price
The retail price of the item.
order.orderitem_set[0].image
The image associated with the item.
order.orderitem_set[0].parent → OrderItem
The parent item, if the item is part of a bundle or set.
Address
Field Name
Description
address.user → User
The user associated with the address.
address.title
The title or label for the address.
address.primary (true/false)
Indicates if this is the primary address.
address.email
The email associated with the address.
address.phone_number
The phone number associated with the address.
address.first_name
The first name of the individual.
address.last_name
The last name of the individual.
address.line
The street address or PO box.
address.postcode
The postal code for the address.
address.notes
Additional notes related to the address.
address.company_name
The company name associated with the address.
address.tax_office
The tax office associated with the address.
address.tax_no
The tax number associated with the address.
address.country.name
The country of the address.
address.city.name
The city of the address.
address.township.name
The township or district of the address.
address.retail_store.name
The name of the retail store, if applicable.
address.identity_number
The national identity number.
Product
Field Name
Description
product.data_source → DataSource
The seller for the product.
product.price
The price of the product.
product.retail_price
The retail price of the product.
product.stock
The stock availability of the product.
product.name
The name of the product.
product.base_code
The base code for the product.
product.sku
The stock keeping unit identifier.
product.product_type
The type of product (e.g., simple, bundle).
product.parent → Product
The parent product, if applicable.
product.get_absolute_url()
The URL for the product's page.
product.main_category → CategoryNode
The main category associated with the product.
product.first_category → CategoryNode
The first category associated with the product.
User
Field Name
Description
user.email_allowed
Indicates if the user allows email communication.
user.sms_allowed
Indicates if the user allows SMS communication.
user.call_allowed
Indicates if the user allows phone calls.
user.phone
The user's phone number.
user.gender
The gender of the user (male, female).
user.date_of_birth
The user's date of birth.
user.user_type
The type of user (registered, guest).
user.first_name
The user's first name.
user.last_name
The user's last name.
user.email
The user's email address.
user.date_joined
The date the user joined the platform.
DataSource
Field Name
Description
data_source.name
The name of the seller.
data_source.title
The title of the seller.
data_source.supplier_code
The supplier code for the seller.
data_source.address
The address of the seller.
data_source.email
The email associated with the seller.
data_source.phone_number
The phone number associated with the seller.
data_source.fax_number
The fax number for the seller.
data_source.kep_address
The KEP (Registered Electronic Mail) address.
data_source.mersis_number
The MERSIS (Central Registration System) number.
CategoryNode
Field Name
Description
category_node.get_absolute_url()
The URL for the category node's page.
category_node.name
The name of the category node.
Last updated
Was this helpful?