Объект содержит информацию о заказе, покупателе, сумме, оплате, адресе доставки и товарах, входящих в заказ.
Поля объекта order
| Тип | Название | Описание |
|---|---|---|
| string | id | Идентификатор заказа |
| integer | number | Внутренний номер заказа |
| datetime | date | Дата заказа |
| string | customer | Название покупателя |
| decimal | sum | Общая сумма заказа |
| decimal | paid | Оплаченная сумма |
| string | deliveryAddress | Адрес доставки |
| array (orderedProduct) | orderedProducts | Список товаров и услуг, входящих в заказ |
| integer | syncStatus | Статус синхронизации заказа |
| integer | version | Версия данных заказа |
Объект товара в заказе — orderedProduct
Объект содержит информацию о товаре или услуге, входящей в заказ.
| Тип | Название | Описание |
|---|---|---|
| string | productId | Идентификатор товара, услуги или разновидности товара |
| string | article | Артикул товара или услуги |
| decimal? | price | Цена продажи |
| decimal | quantity | Количество |
| integer? | vat | Ставка НДС |
Поле syncStatus
Поле syncStatus показывает текущее состояние синхронизации заказа.
| Значение | Описание |
|---|---|
| 1 | Заказ изменён и ожидает синхронизации |
| 2 | Заказ синхронизирован |
Поле version
Поле version содержит версию данных заказа.
Версия используется при подтверждении синхронизации методом orders/setSynced. Заказ будет отмечен как синхронизированный только в том случае, если одновременно совпадают:
- идентификатор заказа;
- версия заказа.
Это позволяет избежать подтверждения синхронизации устаревшей версии данных.
Особенности объекта
Поле orderedProducts возвращается в виде массива.
Если в заказе нет товарных позиций, результат зависит от формирования данных и настроек сериализации: может быть возвращён пустой массив или null.
Поле price может содержать null.
Поле vat может содержать null, если ставка НДС для товарной позиции не указана.
Поле number содержит внутренний номер документа в ЛЭЙМ. Это не обязательно номер заказа, переданный внешней системой при создании заказа.
Поле date содержит только дату заказа. Время при формировании объекта удаляется.
Поле customer содержит название покупателя, а не его идентификатор.
Поле deliveryAddress содержит адрес доставки в текстовом виде.