- Что такое шапка заказа
- Как выглядит шапка заказа
- Спецификация для разметки
- Статусы заказа
- Пример разметки
Что такое шапка заказа
Шапка заказа — это блок, где содержится основная информация о заказе: номер, статус на таймлайне, товары. Она формируется автоматически в начале цепочки писем заказах. Карточка помогает пользователю ориентироваться в своих заказах и сразу видеть информацию о покупке.
Карточка заказа формируется с помощью JSON-LD — это метод передачи связанных данных. Письмо размечают по специальному шаблону, Почта видит эту разметку и преобразует данные в карточку.
Как выглядит карточка заказа
Спецификация для разметки
В этой таблице мы описываем параметры для разметки письма, в котором должна появится шапка заказа. Все параметры делятся на три типа:
- CONST — зарезервированная константа: этот параметр нужно вставить без изменений, как показано в нашем примере, в то же место и с тем же значением;
- REQUIRED — обязательный параметр, для которого вы сами указываете значение;
- OPTIONAL — необязательный параметр.
| Параметр | Описание | Тип | Пример | |||
| @context | Контекст описания объекта | CONST | "@context": "http://schema.org" | |||
| @type | Тип описываемого объекта, в данном случае — Order (заказ) | CONST | "@type": "Order" | |||
| merchant | Сведения о продавце | OPTIONAL |
"merchant": { "@type": "Organization", "name": "PYE Optics" }, |
|||
| @type | Укажите Organization |
CONST | ||||
| name | Название вашей компании | OPTIONAL | ||||
| orderNumber | Номер заказа в вашей системе | REQUIRED | "orderNumber": "123-4567890-1234567" | |||
| orderStatus | Статус заказа. Доступно восемь статусов. Подробнее о них смотрите в таблице ниже | REQUIRED | "orderStatus": "http://schema.org/OrderDelivered" | |||
| priceCurrency | Валюта заказа | OPTIONAL | "priceCurrency": "RUB" | |||
| price | Сумма всего заказа | OPTIONAL | "price": "6500" | |||
| acceptedOffer | Описание заказа | REQUIRED |
"acceptedOffer": { "@type": "Offer", "itemOffered": { "@type": "Product", "name": "Очки Marvin Black jellyfish", "url": "https://pyeoptics.com/..." "image": "https://pyeoptics.com/..." |
|||
| @type | Укажите Offer |
CONST | ||||
| itemOffered | Параметры товара в заказе | REQUIRED | ||||
| @type | Тип описываемого объекта, в данном случае — Product (товар) | CONST | ||||
| name | Название товара в заказе | REQUIRED | ||||
| url | Ссылка на товар в магазине | OPTIONAL | ||||
| image | Изображение | OPTIONAL | ||||
Статусы заказов
| Статус | Описание | Как передавать |
| OrderCancelled | Отменен | "orderStatus": "http://schema.org/OrderCancelled" |
| OrderDelivered | Доставлен | "orderStatus": "http://schema.org/OrderDelivered" |
| OrderInTransit | Заказ в пути | "orderStatus": "http://schema.org/OrderInTransit" |
| OrderPaymentDue | Ожидает оплаты | "orderStatus": "http://schema.org/OrderPaymentDue" |
| OrderPickupAvailable | Ожидает в пункте самовывоза | "orderStatus": "http://schema.org/OrderPickupAvailable" |
| OrderProblem | Проблема | "orderStatus": "http://schema.org/OrderProblem" |
| OrderProcessing | В процессе | "orderStatus": "http://schema.org/OrderProcessing" |
| OrderReturned | Возвращен | "orderStatus": "http://schema.org/OrderReturned" |
Пример разметки
|
<script type="application/ld+json"> { "@context": "http://schema.org", "@type": "Order", "merchant": { "@type": "Organization", "name": "PYE Optics" }, "orderNumber": "123-4567890-1234567", "orderStatus": "http://schema.org/OrderDelivered", "priceCurrency": "RUB", "price": "6500", "acceptedOffer": [{ "@type": "Offer", "itemOffered": { "@type": "Product", "name": "Очки Marvin Black jellyfish", "url": "https://pyeoptics.com/shop/catalogue/marvin_5923/", "image": "https://pyeoptics.com/shop/catalogue/marvin_5923/image1.png" }, "price": "6500", "priceCurrency": "RUB", "eligibleQuantity": { "@type": "QuantitativeValue", "value": "1" } }], "url": "https://pyeoptics.com/shop/cart/cart/orderID=123-4567890-1234567" } </script> |
