> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Order Email Template

Order email triggers when a customer or store admin creates an order.

## Object properties

**`order`** `object`

---

#### order properties

**`id`** `integer`

---

**`customer_message`** `string`

---

**`customer_id`** `integer`

---

**`date_placed`** `object`

---

#### date\_placed properties

**`formatted`** `string`

---

**`value`** `integer`

---

**`account_order_status_url`** `string`

---

**`pickup_methods`** `array`

List of pickup method names for the order

---

**`shipping`** `object`

---

#### shipping properties

**`methods`** `array`

---

**`address`** `object`

---

#### address properties

**`email`** `string`

---

**`phone`** `string`

---

**`first_name`** `string`

---

**`last_name`** `string`

---

**`company`** `string`

---

**`country`** `string`

---

**`city`** `string`

---

**`state`** `string`

---

**`zip`** `string`

---

**`address_lines`** `array`

---

**`custom_fields`** `array[object]`

---

#### custom\_fields items

**`label`** `string`

---

**`value`** `string`

---

**`products`** `array[object]`

---

#### products items

**`name`** `string`

---

**`quantity`** `integer`

---

**`sku`** `string`

---

**`address_lines`** `array`

---

**`address_custom_fields`** `array[object]`

Contains the label and value for custom form fields on the address.

---

#### address\_custom\_fields items

**`label`** `string`

---

**`value`** `string`

---

**`address_id`** `integer`

---

**`options`** `object`

---

#### options properties

**`Size`** `string`

---

**`download_url`** `string`

---

**`thumbnail`** `string`

---

**`brand`** `string`

---

**`type`** `string`

Product type

---

**`event`** `object`

---

#### event properties

**`name`** `string`

---

**`date`** `object`

---

#### date properties

**`value`** `integer`

---

**`formatted`** `string`

---

**`price`** `object`

---

#### price properties

**`value`** `float`

---

**`formatted`** `string`

---

**`total`** `object`

---

#### total properties

**`value`** `float`

---

**`formatted`** `string`

---

**`preorder`** `object`

---

#### preorder properties

**`is_preorder`** `boolean`

---

**`message`** `string`

---

**`date`** `object`

---

#### date properties

**`value`** `integer`

---

**`formatted`** `string`

---

**`attribute_lines`** `array`

A list of strings that represents product variant options.

---

**`configurable_fields`** `array[object]`

Object array with properties name and value.

---

#### configurable\_fields items

**`name`** `string`

---

**`value`** `string`

---

**`pickup`** `object`

Pickup information for the product

---

#### pickup properties

**`id`** `string`

---

**`email`** `string`

---

**`phone`** `string`

---

**`instructions`** `string`

---

**`name`** `string`

---

**`location`** `object`

---

#### location properties

**`id`** `string`

---

**`name`** `string`

---

**`address`** `string`

---

**`city`** `string`

---

**`state`** `string`

---

**`zip`** `string`

---

**`country`** `string`

---

**`operating_hours`** `object`

---

#### operating\_hours properties

**`sunday`** `object`

---

#### sunday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`monday`** `object`

---

#### monday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`tuesday`** `object`

---

#### tuesday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`wednesday`** `object`

---

#### wednesday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`thursday`** `object`

---

#### thursday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`friday`** `object`

---

#### friday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`saturday`** `object`

---

#### saturday properties

**`is_open`** `boolean`

---

**`opening_time`** `object`

---

#### opening\_time properties

**`formatted`** `string`

---

**`closing_time`** `object`

---

#### closing\_time properties

**`formatted`** `string`

---

**`payment`** `object`

---

#### payment properties

**`is_test`** `boolean`

---

**`provider_name`** `string`

---

**`offline_payment_message`** `string`

---

**`gateway_amount`** `object`

Price value. Provided only if the payment method is offline.

---

#### gateway\_amount properties

**`formatted`** `string`

---

**`value`** `float`

---

**`payment_method`** `string`

Payment method name

---

**`provider`** `object`

---

#### provider properties

**`name`** `string`

Payment provider name

---

**`billing`** `object`

---

#### billing properties

**`is_managed_by_amazon`** `boolean`

---

**`address`** `object`

---

#### address properties

**`email`** `string`

---

**`phone`** `string`

---

**`first_name`** `string`

---

**`last_name`** `string`

---

**`company`** `string`

---

**`country`** `string`

---

**`city`** `string`

---

**`state`** `string`

---

**`zip`** `string`

---

**`address_lines`** `array`

---

**`custom_fields`** `array[object]`

---

#### custom\_fields items

**`label`** `string`

---

**`value`** `string`

---

**`total_rows`** `array[object]`

---

#### total\_rows items

**`label`** `string`

---

**`price`** `object`

---

#### price properties

**`value`** `float`

---

**`formatted`** `string`

---

**`shipping_discounts`** `array`

---

**`total_cost`** `object`

---

#### total\_cost properties

**`formatted`** `string`

---

**`value`** `float`

---

**`meta`** `object`

---

#### meta properties

**`mandate_url`** `string`

Link to the confirmation page in Stripe

---

**`mandate_tag`** `string`

Short name of the payment document

---

**`mandate_id`** `string`

Unique identifier for the payment mandate

---

**`shipping_addresses_num`** `integer`

---

**`show_immediate_download`** `boolean`

---

**`store`** `object`

---

#### store properties

**`name`** `string`

---

**`domain_name`** `string`

---

**`logo`** `object`

---

#### logo properties

**`title`** `string`

---

**`name`** `string`

---

**`url`** `string`

---

**`ssl_path`** `string`

---

**`cdn_path`** `string`

---

**`image_directory`** `string`

---

**`img_path`** `string`

---

**`path_normal`** `string`

Path to the store (i.e., domain + protocol)

---

**`path`** `string`

---

**`address`** `string`

---

**`language`** `object`

---

#### language properties

**`code`** `string`

---

**`direction`** `string`

Left to right or right to left, depending on the language

---

**`customer`** `object`

---

#### customer properties

**`first_name`** `string`

---

**`full_name`** `string`

---

**`email`** `string`

---

**`group`** `array[object]`

---

#### group items

**`name`** `string`

---

**`misc`** `object`

---

#### misc properties

**`year`** `integer`

---

**`translations`** `object`

---

#### translations properties

**`en`** `object`

---

#### en properties

**`comment_label`** `string`

---

**`order_id_line`** `string`

---

**`view_summary`** `string`

---

**`sepa`** `string`

A link to SEPA mandate and also receive this link embedded on email confirmation.

---

**`shipment_to_multiple_addresses`** `string`

---

**`shipping_immediate_download`** `string`

---

**`shipping_address_label`** `string`

---

**`immediate_download`** `string`

---

**`email`** `string`

---

**`billing_address_managed_by_amazon`** `string`

---

**`billing_address_label`** `string`

---

**`pending_payment`** `string`

---

**`how_to_pay`** `string`

---

**`pay_for_order_help`** `string`

---

**`order_total`** `string`

---

**`cart_items`** `string`

---

**`sku`** `string`

---

**`quantity`** `string`

---

**`item_price`** `string`

---

**`item_total`** `string`

---

**`payment_method`** `string`

---

**`no_payment_taken_in_test_mode`** `string`

---

**`download_files`** `string`

---

**`preorder`** `string`

---

**`download_available_after_payment`** `string`

---

**`shipped_to`** `string`

---

**`shipping_discount`** `string`

---

**`thanks_for_your_order`** `string`

---

**`your_order_contains`** `string`

---

**`shipping_method`** `string`

---

**`shipping_to_address`** `string`

---

**`your_order_will_be_shipped_by`** `string`

---

**`total_cost`** `string`

---

**`items`** `string`

---

**`total`** `string`

---

**`price`** `string`

---

**`email_address`** `string`

---

## Example

```json showLineNumbers={false}
{
  "order": {
    "id": 1,
    "customer_message": "Order custom message",
    "customer_id": 11,
    "date_placed": {
      "formatted": "11th Feb 2021",
      "value": 1613060604
    },
    "account_order_status_url": null,
    "pickup_methods": [
      "Store Pickup",
      "Curbside Pickup"
    ],
    "shipping": {
      "methods": null,
      "address": {
        "email": "customer@example.com",
        "phone": 112233445566,
        "first_name": "John",
        "last_name": "Wick",
        "company": "MyCompany",
        "country": null,
        "city": null,
        "state": null,
        "zip": 1622,
        "address_lines": null,
        "custom_fields": null
      }
    },
    "products": [
      {
        "name": "Sample Product",
        "quantity": 2,
        "sku": "SF42",
        "address_lines": null,
        "address_custom_fields": null,
        "address_id": 0,
        "options": {
          "Size": "XL"
        },
        "download_url": "https://example.com/download/file.pdf",
        "thumbnail": "/test.jpg",
        "brand": "Nike",
        "type": "physical",
        "event": {
          "name": "Summer Sale Event",
          "date": {
            "value": 1640995200,
            "formatted": "Jan 1, 2022"
          }
        },
        "price": {
          "value": 250.1,
          "formatted": 250.1
        },
        "total": {
          "value": "250.1,",
          "formatted": 250.1
        },
        "preorder": {
          "is_preorder": false,
          "message": "Available for pre-order",
          "date": {
            "value": 1640995200,
            "formatted": "Jan 1, 2022"
          }
        },
        "attribute_lines": null,
        "configurable_fields": null,
        "pickup": {
          "id": "pickup_123",
          "email": "pickup@store.com",
          "phone": "+1234567890",
          "instructions": "Please call when you arrive",
          "name": "Main Store Location",
          "location": {
            "id": "loc_456",
            "name": "Downtown Store",
            "address": "123 Main St",
            "city": "New York",
            "state": "NY",
            "zip": "10001",
            "country": "US"
          },
          "operating_hours": {
            "sunday": {
              "is_open": true,
              "opening_time": {
                "formatted": "10:00"
              },
              "closing_time": {
                "formatted": "18:00"
              }
            },
            "monday": {
              "is_open": true,
              "opening_time": {
                "formatted": "09:00"
              },
              "closing_time": {
                "formatted": "20:00"
              }
            },
            "tuesday": {
              "is_open": true,
              "opening_time": {
                "formatted": "09:00"
              },
              "closing_time": {
                "formatted": "20:00"
              }
            },
            "wednesday": {
              "is_open": true,
              "opening_time": {
                "formatted": "09:00"
              },
              "closing_time": {
                "formatted": "20:00"
              }
            },
            "thursday": {
              "is_open": true,
              "opening_time": {
                "formatted": "09:00"
              },
              "closing_time": {
                "formatted": "20:00"
              }
            },
            "friday": {
              "is_open": true,
              "opening_time": {
                "formatted": "09:00"
              },
              "closing_time": {
                "formatted": "21:00"
              }
            },
            "saturday": {
              "is_open": true,
              "opening_time": {
                "formatted": "10:00"
              },
              "closing_time": {
                "formatted": "19:00"
              }
            }
          }
        }
      }
    ],
    "payment": {
      "is_test": false,
      "provider_name": "PaymentMethod",
      "offline_payment_message": "Please pay at store",
      "gateway_amount": {
        "formatted": "$100.00",
        "value": 100.0
      },
      "payment_method": "Credit Card",
      "provider": {
        "name": "Stripe"
      }
    },
    "billing": {
      "is_managed_by_amazon": false,
      "address": {
        "email": "customer@example.com",
        "phone": 112233445566,
        "first_name": "John",
        "last_name": "Wick",
        "company": "MyCompany",
        "country": null,
        "city": null,
        "state": null,
        "zip": 1622,
        "address_lines": null,
        "custom_fields": null
      }
    },
    "total_rows": [
      {
        "label": "Total,",
        "price": {
          "value": "250.1,",
          "formatted": 250.1
        },
        "shipping_discounts": null
      }
    ],
    "total_cost": {
      "formatted": "100.0$,",
      "value": 100
    },
    "meta": {
      "mandate_url": "https://stripe.com/mandate/123456",
      "mandate_tag": "SEPA Direct Debit",
      "mandate_id": "mandate_123456789",
      "shipping_addresses_num": 1,
      "show_immediate_download": false
    }
  },
  "store": {
    "name": "My Dev Store 97434969",
    "domain_name": "my-dev-store-97434969.store.bcdev",
    "logo": {
      "title": [
        "= My Dev Store 97434969 ="
      ],
      "name": "avatar-2020_1612860757__16350.jpeg",
      "url": "https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96/product_images/avatar-2020_1612860757__16350.jpeg"
    },
    "ssl_path": "https://my-dev-store-97434969.store.bcdev",
    "cdn_path": "https://valeryderived-cloud-dev-vm.store.bcdev/store/f1kr2akw96",
    "image_directory": "product_images",
    "img_path": "https://valeryderived-cloud-dev-vm.store.bcdev/r08d84bb67d250c7624502ed76d8e0bafb1a5cacf/g-themes/ClassicNext/images",
    "path_normal": "https://my-dev-store-97434969.store.bcdev",
    "path": "https://my-dev-store-97434969.store.bcdev",
    "address": "123 Fake St, Dallas, TX 75225",
    "language": {
      "code": "en",
      "direction": "ltr"
    }
  },
  "customer": {
    "first_name": "John,",
    "full_name": "John Jr",
    "email": "john.f@example.com"
  },
  "misc": {
    "year": 2021
  },
  "translations": {
    "en": {
      "comment_label": "Order Instructions/Comments",
      "order_id_line": "Your order ID is <strong>#{{id}}</strong>.",
      "view_summary": "A summary of your order is shown below. To view the status of your order <a href='link'>click here</a>.",
      "sepa": "SEPA Direct Debit Mandate",
      "shipment_to_multiple_addresses": "(Order will be shipped to multiple addresses)",
      "shipping_immediate_download": "Immediate download after completion of payment.",
      "shipping_address_label": "Shipping Address",
      "immediate_download": "Immediate Download",
      "email": "Email",
      "billing_address_managed_by_amazon": "Managed by Amazon",
      "billing_address_label": "Billing Address",
      "pending_payment": "Your order requires payment before it can be finalized. Details on how to pay are shown below.",
      "how_to_pay": "Your order requires payment before it can be finalized. Details on how to pay are shown below.",
      "pay_for_order_help": "Once you've provided payment your order will be completed.",
      "order_total": "The outstanding balance of your order is amount",
      "cart_items": "Cart Items",
      "sku": "SKU",
      "quantity": "Qty",
      "item_price": "Item Price",
      "item_total": "Item Total",
      "payment_method": "Payment Method",
      "no_payment_taken_in_test_mode": "<b>Please Note</b>: No money was taken for this order, because the payment provider is in test mode.",
      "download_files": "Download Files",
      "preorder": "This product is available for pre-order only",
      "download_available_after_payment": "Items available for immediate download after completion of payment",
      "shipped_to": "Items shipped to address",
      "shipping_discount": "price off using code Coupon Code",
      "thanks_for_your_order": "Thanks for Your Order",
      "your_order_contains": "Your Order Contains...",
      "shipping_method": "Shipping Method",
      "shipping_to_address": "Shipping to Address",
      "your_order_will_be_shipped_by": "Your Order Will Be Shipped By...",
      "total_cost": "Total Cost",
      "items": "Items",
      "total": "Total",
      "price": "Price",
      "email_address": "Email Address"
    }
  }
}
```