Online stores

Your emails to customers can be presented in a special way in the list of incoming messages. To do that, include order information in the email using Schema.org markup.

An order cancellation email will be highlighted in gray in the email list. All the previous emails about that order will be highlighted in gray too if they contain the correct order number and status.

How to mark up emails

To mark up your emails:

  1. Take into account the Yandex requirements for mail-outs. Make sure that the domain you want to send the emails from complies with the requirements.

  2. Use the Order type of the Schema.org standard supported by Yandex Mail and one of two data description formats: Microdata or JSON-LD.

    • JSON-LD markup should be pasted into the head element of the email's HTML code.

    • Microdata should be added as extra attributes for elements in the email's HTML code.

  3. Validate your markup.

If you did everything listed above but your markup doesn't work, fill out the form at the bottom of the page:

  1. Select "Widgets (highlighting emails in the email list)".
  2. In your message, specify the domain you want to send emails from.
  3. Wait for a response from the support team.

Markup example for an email with order information

To notify a customer of order confirmation, include the orderStatus property in your email markup and set its value to http://schema.org/orderProcessing. To inform the customer about a different order status, select the appropriate value of the orderStatus property.

JSON-LD
<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "Order",
  "merchant": {
    "@type": "Organization",
    "name": "Wonderland"
  },
  "orderNumber": "12345678",
  "orderStatus": "http://schema.org/OrderProcessing", 
  "priceCurrency": "RUB", 
  "price": "240",  // Total order amount
  "expectedArrivalUntil": "2013-03-12T12:00:00-08:00", // Delivery date
  "trackingNumber": "3453291231",
  "trackingUrl": "http://example.com/track/3453291231", // Used for the quick access button to order tracking
  "url": "https://example.com/edit.html/orderID=12345678", // Used for the quick order button on the store's website.
  "acceptedOffer": {
    "@type": "Offer",
    "itemOffered": {
      "@type": "Product",
      "name": "Berry tea from the Hatter"
    }
  }
}
</script>
Microdata
<div itemscope itemtype="http://schema.org/Order">
  <div itemprop="merchant" itemscope itemtype="http://schema.org/Organization">
    <meta itemprop="name" content="Wonderland"/>
  </div>
  <link itemprop="orderStatus" href="http://schema.org/OrderProcessing"/>
  <meta itemprop="orderNumber" content="12345678"/>
  <meta itemprop="priceCurrency" content="RUB"/>
  <meta itemprop="price" content="240"/> // Total order amount
  <link itemprop="url" href="https://example.com/edit.html/orderID=12345678"/> // Used for the quick order button on the store's website
  <meta itemprop="expectedArrivalUntil content="2013-03-12T12:00:00-08:00/>
  <meta itemprop="trackingNumber" content="3453291231"/>
  <link itemprop="trackingUrl" href="http://example.com/track/3453291231"/> // Used for the quick access button to order tracking
  <div itemprop="acceptedOffer" itemscope itemtype="http://schema.org/Offer">
    <div itemprop="itemOffered" itemscope itemtype="http://schema.org/Product">
      <meta itemprop="name" content="Berry tea from the Hatter"/>
    </div>
    <meta itemprop="price" content="240"/> // The cost of the product
    <meta itemprop="priceCurrency" content="RUB"/>
  </div>
</div>

Properties of the Order type supported by Yandex Mail

Property

Type

Description

acceptedOffer

Offer

The products or service bookings included in the order.

acceptedOffer.itemOffered

Product or Reservation

A specific product or service booking in the order.

acceptedOffer.itemOffered.name

Text

The product or service name.

expectedArrivalUntil

DateTime

The estimated delivery date.

merchant

Organization or Person

The type of seller: a store or an individual.

This field can also contain a string (for example, "Hatter").

merchant.name

Text

The seller's name.

orderNumber

Text

The order number.

orderStatus

OrderStatus

The order status.

Possible values

priceCurrency

Text

The currency.

price

Number or Text

The product price or total order cost.

trackingNumber

Text

The tracking number.

trackingUrl

URL

A link to the order tracking page.

url

URL

A link to the order page or to the user's account.

Values of the orderStatus property

  • "http://schema.org/OrderProcessing": Order has been confirmed and is being processed.
  • "http://schema.org/OrderCancelled": Order has been canceled.
  • "http://schema.org/OrderDelivered": Order has been delivered.
  • "http://schema.org/OrderInTransit": Order is in transit.
  • "http://schema.org/OrderPaymentDue": Order payment deadline is expiring.
  • "http://schema.org/OrderPickupAvailable": Pickup available.
  • "http://schema.org/OrderProblem": Problem with the order.
  • "http://schema.org/OrderReturned": Order has been returned.

Contact support



You can also go to

  • "http://schema.org/OrderProcessing": Order has been confirmed and is being processed.
  • "http://schema.org/OrderCancelled": Order has been canceled.
  • "http://schema.org/OrderDelivered": Order has been delivered.
  • "http://schema.org/OrderInTransit": Order is in transit.
  • "http://schema.org/OrderPaymentDue": Order payment deadline is expiring.
  • "http://schema.org/OrderPickupAvailable": Pickup available.
  • "http://schema.org/OrderProblem": Problem with the order.
  • "http://schema.org/OrderReturned": Order has been returned.

Type

OrderStatus

Description

Order status.

Possible values