Skip to content

Order entity

Generate coherent orders with products, customer, addresses, payment, fulfilment, and monetary totals.

Why: Use Order when an ecommerce scenario needs one coherent aggregate spanning customer, products, addresses, payment, fulfilment, and monetary totals; compose fields manually for deliberately inconsistent edge cases.

1
<variable name="value" entity="Order"/>

Output: Typed Order value.

Parameters

  • dataset: str | null; Default None — Country dataset shared by the order's nested customer and address data.

Attributes

  • billing_address (dict): Billing address fields.
  • coupon_code (str | None): Coupon identifier when a discount is applied.
  • currency (str): ISO currency code for monetary amounts.
  • date (datetime): Timestamp the order was placed.
  • discount_amount (float): Discount or promotion applied.
  • notes (str | None): Free-form order notes.
  • order_id (str): Synthetic order identifier.
  • payment_method (str): Payment instrument used.
  • product_list (list[Product]): Line items included in the order.
  • shipping_address (dict): Shipping destination address fields.
  • shipping_amount (float): Shipping charges applied.
  • shipping_method (str): Selected shipping method.
  • status (str): Order fulfillment status.
  • tax_amount (float): Tax charged on the order.
  • total_amount (float): Order grand total after adjustments.
  • user_id (str): Customer identifier associated with the order.

Limits

The available attributes and values depend on the registered entity, its dataset, and its documented constructor options.