Применение документа

POST /v1/wp/applyDocument
Создание или калькуляция чека
Чтобы закрыть чек необходимо передать close=1 через GET параметр
Содержимое запроса:

MakeDocumentDto
  • document
    objectобязательный
    DocumentДокумент
    • number
      stringобязательный
    • uuid
      objectобязательный
      Уникальный id чека
    • type
      enumобязательный
      Тип чека
      • sell
        string
        Продажа
      • refund
        string
        Возврат
    • date
      objectобязательный
      Дата создания чека
    • member_auth
      object?не обязательный
      Document.MemberAuthАутентификация клиента
      • card
        string?не обязательный
        Карта клиента
      • phone
        string?не обязательный
        Телефон клиента
      • email
        string?не обязательный
        Электронная почта клиента
      • raw_id
        long?не обязательный
        Идентификатор клиента
    • member_id
      long?не обязательный
      Идентификатор клиента
    • company
      long?не обязательный
      Идентификатор организации
    • common_member_id
      object?не обязательный
      Общей идентификатор клиента
    • terminal_id
      long?не обязательный
      Идентификатор терминала
    • positions
      arrayне обязательный
      Позиции чека
      • items
        objectобязательный
        Document.Position
        • code
          stringобязательный
          Код товара
        • vendorCode
          string?не обязательный
          Артикул
        • quantity
          longне обязательный
          Количество товара в позиции
        • amount
          longне обязательный
        • changes
          array?не обязательный
          Изменения позиции
          • items
            objectобязательный
            Document.Change
            • bonus_change
              object?не обязательный
              Document.Change.BonusChange
              • member_id
                longобязательный
                Идентификатор клиента
              • change
                longобязательный
                Сумма изменения бонусов
              • start
                objectобязательный
                Дата активации бонусов
              • end
                object?не обязательный
                Дата сгорания бонусов
              • comments
                string?не обязательный
                Комментарий транзакции. Доступно клиенту
              • description
                string?не обязательный
                Описание записи. Доступно только внутри системы
            • discount_change
              object?не обязательный
              Document.Change.DiscountChange
              • change
                longобязательный
            • display_message
              object?не обязательный
              Document.Change.DisplayMessage
              • text
                stringобязательный
            • print_message
              object?не обязательный
              Document.Change.PrintMessage
              • text
                stringобязательный
            • tag_update
              object?не обязательный
              Document.Change.TagUpdate
              • add
                arrayобязательный
                Список идентификаторов меток для добавления
                • items
                  longобязательный
              • delete
                arrayобязательный
                Список идентификаторов меток для удаления
                • items
                  longобязательный
              • member_id
                longобязательный
                Идентификатор клиента
            • max_bonus_pay
              object?не обязательный
              Document.Change.SetMaxBonusPay
              • max_pay
                longобязательный
                Максимальная сумма оплаты бонусами
            • promoId
              object?не обязательный
              Идентификатор акции, применившей изменение
            • meta
              object?не обязательный
              Мета информация
              • 0
                stringобязательный
              • 1
                stringобязательный
        • meta
          object?не обязательный
          Мета информация
          • 0
            stringобязательный
          • 1
            stringобязательный
    • payments
      arrayне обязательный
      Оплаты чека
      • items
        objectобязательный
        Document.Payment
        • amount
          longобязательный
        • type
          enumобязательный
          • cash
            string
          • credit_card
            string
          • other
            string
        • meta
          object?не обязательный
          Мета информация
          • 0
            stringобязательный
          • 1
            stringобязательный
    • changes
      array?не обязательный
      Изменения чека
      • items
        objectобязательный
        Document.Change
        • bonus_change
          object?не обязательный
          Document.Change.BonusChange
          • member_id
            longобязательный
            Идентификатор клиента
          • change
            longобязательный
            Сумма изменения бонусов
          • start
            objectобязательный
            Дата активации бонусов
          • end
            object?не обязательный
            Дата сгорания бонусов
          • comments
            string?не обязательный
            Комментарий транзакции. Доступно клиенту
          • description
            string?не обязательный
            Описание записи. Доступно только внутри системы
        • discount_change
          object?не обязательный
          Document.Change.DiscountChange
          • change
            longобязательный
        • display_message
          object?не обязательный
          Document.Change.DisplayMessage
          • text
            stringобязательный
        • print_message
          object?не обязательный
          Document.Change.PrintMessage
          • text
            stringобязательный
        • tag_update
          object?не обязательный
          Document.Change.TagUpdate
          • add
            arrayобязательный
            Список идентификаторов меток для добавления
            • items
              longобязательный
          • delete
            arrayобязательный
            Список идентификаторов меток для удаления
            • items
              longобязательный
          • member_id
            longобязательный
            Идентификатор клиента
        • max_bonus_pay
          object?не обязательный
          Document.Change.SetMaxBonusPay
          • max_pay
            longобязательный
            Максимальная сумма оплаты бонусами
        • promoId
          object?не обязательный
          Идентификатор акции, применившей изменение
        • meta
          object?не обязательный
          Мета информация
          • 0
            stringобязательный
          • 1
            stringобязательный
    • display_messages
      array?не обязательный
      Сообщения кассиру
      • items
        objectобязательный
        Document.Message
        • text
          stringобязательный
          Текст сообщения
        • promo_id
          object?не обязательный
          Идентификатор акции
    • print_messages
      array?не обязательный
      Сообщения в бумажном чеке
      • items
        objectобязательный
        Document.Message
        • text
          stringобязательный
          Текст сообщения
        • promo_id
          object?не обязательный
          Идентификатор акции
    • refund_uid
      object?не обязательный
      Уникальный номер чека основания
    • device
      enum?не обязательный
      Тип устройства кассы
      • web
        string
        Веб-клиент
      • tradeline_client
        string
        TradeLine клиент
      • frontol_api
        string
        FrontolApi
      • evotor
        string
        Evotor клиент
    • meta
      object?не обязательный
      Мета информация
      • 0
        stringобязательный
      • 1
        stringобязательный
  • debug
    booleanобязательный
    Флаг использования акций в режиме тестирования

Ответ сервера:

OrderSnapshot
  • document
    objectобязательный
    DocumentРезультирующий документ
    • number
      stringобязательный
    • uuid
      objectобязательный
      Уникальный id чека
    • type
      enumобязательный
      Тип чека
      • sell
        string
        Продажа
      • refund
        string
        Возврат
    • date
      objectобязательный
      Дата создания чека
    • member_auth
      object?не обязательный
      Document.MemberAuthАутентификация клиента
      • card
        string?не обязательный
        Карта клиента
      • phone
        string?не обязательный
        Телефон клиента
      • email
        string?не обязательный
        Электронная почта клиента
      • raw_id
        long?не обязательный
        Идентификатор клиента
    • member_id
      long?не обязательный
      Идентификатор клиента
    • company
      long?не обязательный
      Идентификатор организации
    • common_member_id
      object?не обязательный
      Общей идентификатор клиента
    • terminal_id
      long?не обязательный
      Идентификатор терминала
    • positions
      arrayне обязательный
      Позиции чека
      • items
        objectобязательный
        Document.Position
        • code
          stringобязательный
          Код товара
        • vendorCode
          string?не обязательный
          Артикул
        • quantity
          longне обязательный
          Количество товара в позиции
        • amount
          longне обязательный
        • changes
          array?не обязательный
          Изменения позиции
          • items
            objectобязательный
            Document.Change
            • bonus_change
              object?не обязательный
              Document.Change.BonusChange
              • member_id
                longобязательный
                Идентификатор клиента
              • change
                longобязательный
                Сумма изменения бонусов
              • start
                objectобязательный
                Дата активации бонусов
              • end
                object?не обязательный
                Дата сгорания бонусов
              • comments
                string?не обязательный
                Комментарий транзакции. Доступно клиенту
              • description
                string?не обязательный
                Описание записи. Доступно только внутри системы
            • discount_change
              object?не обязательный
              Document.Change.DiscountChange
              • change
                longобязательный
            • display_message
              object?не обязательный
              Document.Change.DisplayMessage
              • text
                stringобязательный
            • print_message
              object?не обязательный
              Document.Change.PrintMessage
              • text
                stringобязательный
            • tag_update
              object?не обязательный
              Document.Change.TagUpdate
              • add
                arrayобязательный
                Список идентификаторов меток для добавления
                • items
                  longобязательный
              • delete
                arrayобязательный
                Список идентификаторов меток для удаления
                • items
                  longобязательный
              • member_id
                longобязательный
                Идентификатор клиента
            • max_bonus_pay
              object?не обязательный
              Document.Change.SetMaxBonusPay
              • max_pay
                longобязательный
                Максимальная сумма оплаты бонусами
            • promoId
              object?не обязательный
              Идентификатор акции, применившей изменение
            • meta
              object?не обязательный
              Мета информация
              • 0
                stringобязательный
              • 1
                stringобязательный
        • meta
          object?не обязательный
          Мета информация
          • 0
            stringобязательный
          • 1
            stringобязательный
    • payments
      arrayне обязательный
      Оплаты чека
      • items
        objectобязательный
        Document.Payment
        • amount
          longобязательный
        • type
          enumобязательный
          • cash
            string
          • credit_card
            string
          • other
            string
        • meta
          object?не обязательный
          Мета информация
          • 0
            stringобязательный
          • 1
            stringобязательный
    • changes
      array?не обязательный
      Изменения чека
      • items
        objectобязательный
        Document.Change
        • bonus_change
          object?не обязательный
          Document.Change.BonusChange
          • member_id
            longобязательный
            Идентификатор клиента
          • change
            longобязательный
            Сумма изменения бонусов
          • start
            objectобязательный
            Дата активации бонусов
          • end
            object?не обязательный
            Дата сгорания бонусов
          • comments
            string?не обязательный
            Комментарий транзакции. Доступно клиенту
          • description
            string?не обязательный
            Описание записи. Доступно только внутри системы
        • discount_change
          object?не обязательный
          Document.Change.DiscountChange
          • change
            longобязательный
        • display_message
          object?не обязательный
          Document.Change.DisplayMessage
          • text
            stringобязательный
        • print_message
          object?не обязательный
          Document.Change.PrintMessage
          • text
            stringобязательный
        • tag_update
          object?не обязательный
          Document.Change.TagUpdate
          • add
            arrayобязательный
            Список идентификаторов меток для добавления
            • items
              longобязательный
          • delete
            arrayобязательный
            Список идентификаторов меток для удаления
            • items
              longобязательный
          • member_id
            longобязательный
            Идентификатор клиента
        • max_bonus_pay
          object?не обязательный
          Document.Change.SetMaxBonusPay
          • max_pay
            longобязательный
            Максимальная сумма оплаты бонусами
        • promoId
          object?не обязательный
          Идентификатор акции, применившей изменение
        • meta
          object?не обязательный
          Мета информация
          • 0
            stringобязательный
          • 1
            stringобязательный
    • display_messages
      array?не обязательный
      Сообщения кассиру
      • items
        objectобязательный
        Document.Message
        • text
          stringобязательный
          Текст сообщения
        • promo_id
          object?не обязательный
          Идентификатор акции
    • print_messages
      array?не обязательный
      Сообщения в бумажном чеке
      • items
        objectобязательный
        Document.Message
        • text
          stringобязательный
          Текст сообщения
        • promo_id
          object?не обязательный
          Идентификатор акции
    • refund_uid
      object?не обязательный
      Уникальный номер чека основания
    • device
      enum?не обязательный
      Тип устройства кассы
      • web
        string
        Веб-клиент
      • tradeline_client
        string
        TradeLine клиент
      • frontol_api
        string
        FrontolApi
      • evotor
        string
        Evotor клиент
    • meta
      object?не обязательный
      Мета информация
      • 0
        stringобязательный
      • 1
        stringобязательный
  • promotions
    arrayобязательный
    Сработавшие акции
    • items
      objectобязательный
      org.tlsys.admin.OrderPromotionRecord
      • type
        enumобязательный
        Тип акции
        • BONUS_BY_PAYED_AND_DOC_PAY_WITH_LEVELS
          string
        • DISCOUNT_BY_PAYED_AND_DOC_PAY_WITH_LEVELS
          string
        • DISCOUNT_BY_TAGS
          string
        • SET_MAX_DISCOUNT
          string
        • DISCOUNT_EXTERNAL
          string
        • MAX_PAY_EXTERNAL
          string
        • BONUS_APPLY_EXTERNAL
          string
        • TAG_SETTER
          string
        • ADD_BONUS
          string
      • id
        objectобязательный
        Идентификатор акции
      • params
        stringобязательный
        Параметры акции
      • title
        stringобязательный
        Заголовок акции
      • owner_user_id
        longобязательный
        Идентификатор пользователя владельца акции
      • status
        enumобязательный
        Статус акции
        • DISABLED
          string
          Не активна
        • ACTIVE
          string
          Активна
        • DRAFT
          string
          Черновик
        • DEBUG
          string
          Отладка
      • create_date
        objectобязательный
        Дата создания акции
      • start_date
        objectобязательный
        Дата старта акции
      • end_date
        object?обязательный
        Дата окончания акции
  • discards
    arrayобязательный
    Не сработавшие акции
    • items
      objectобязательный
      org.tlsys.dto.OrderSnapshot.DiscardReason
      • promotion
        objectобязательный
        org.tlsys.admin.OrderPromotionRecordАкция
        • type
          enumобязательный
          Тип акции
          • BONUS_BY_PAYED_AND_DOC_PAY_WITH_LEVELS
            string
          • DISCOUNT_BY_PAYED_AND_DOC_PAY_WITH_LEVELS
            string
          • DISCOUNT_BY_TAGS
            string
          • SET_MAX_DISCOUNT
            string
          • DISCOUNT_EXTERNAL
            string
          • MAX_PAY_EXTERNAL
            string
          • BONUS_APPLY_EXTERNAL
            string
          • TAG_SETTER
            string
          • ADD_BONUS
            string
        • id
          objectобязательный
          Идентификатор акции
        • params
          stringобязательный
          Параметры акции
        • title
          stringобязательный
          Заголовок акции
        • owner_user_id
          longобязательный
          Идентификатор пользователя владельца акции
        • status
          enumобязательный
          Статус акции
          • DISABLED
            string
            Не активна
          • ACTIVE
            string
            Активна
          • DRAFT
            string
            Черновик
          • DEBUG
            string
            Отладка
        • create_date
          objectобязательный
          Дата создания акции
        • start_date
          objectобязательный
          Дата старта акции
        • end_date
          object?обязательный
          Дата окончания акции
      • text
        stringобязательный
        Причина отказа

TradeLine — бонусная программа для магазина или кафе | Личный кабинет
ООО «ТрейдЛайн», ИНН: 0245951331