МойСклад POS API 1.0

API Endpoint
https://online.moysklad.ru/api/posap/1.0

API для подключения торговой точки к онлайн-сервису МойСклад.

Основная информация

Замечания по разработке клиентских приложений

При разработке клиентского приложения необходимо учитывать следующие моменты:

  • Структура ответов и типы полей поддерживаются нами неизменными

  • Может быть добавлено новое поле без нарушения структуры ответа

  • Может быть добавлен новый ресурс

Ограничения

Для POS API установлены следующие ограничения:

  • Не более 100 запросов за 5 секундный период

  • Не более 5 параллельных запросов от одного пользователя

  • Не более 15 параллельных запросов от аккаунта

  • Не более 500 параллельных запросов с одного ip-адреса

  • Не более 10 Мб данных в одном запросе, отправляемом на сервер

Обмен информацией

Получение информации

В рамках POS API вы можете:
Запрашивать следующие сущности:

При запросе сущности в ответ от сервера приходит JSON представление сущности со всеми необходимыми для работы с ней в рознице полями.

Создание объектов

Также, в рамках POS API можно создавать следующие сущности:

При успешном создании сервер вернет пустое тело ответа с HTTP кодом 201.

Операции со сменами

Также доступны 2 операции со сменами:

При успешной операции со сменой сервер вернёт пустое тело ответа с HTTP кодом 204.

Обновление сущностей

Розничный API сервиса МойСклад не поддерживает операции обновления сущностей.

Удаление сущностей

Розничный API сервиса МойСклад не поддерживает операции удаления сущностей.

Обработка ошибок

СТРУКТУРА ОШИБОК

Ошибка в данном API представляет собой массив errors, содержащий объекты error, каждый из которых описывает отдельную ошибку.

СТРУКТУРА ОБЪЕКТА error

  • error - Описание ошибки

  • code - Код ошибки (Если поле отсутствует, смотрите HTTP status code)

  • moreInfo - Ссылка на описание ошибки в документации

  • parameter - Параметр, на котором произошла ошибка

  • line - Строка JSON, на которой произошла ошибка

  • column - Координата элемента в строке line, на котором произошла ошибка

Возвращаемые HTTP статусы ошибок и их значения:

HTTP status code Значение
301 Запрашиваемый ресурс находится по другому URL.
400 Ошибка в структуре JSON передаваемого запроса
401 Имя и/или пароль пользователя указаны неверно или заблокированы пользователь или аккаунт
403 У вас нет прав на просмотр данного объекта
404 Запрошенный ресурс не существует
405 http-метод указан неверно для запрошенного ресурса
409 Указанный объект используется и не может быть удалён
410 Версия API больше не поддерживается
412 Не указан обязательный параметр строки запроса или поле структуры JSON
413 Размер запроса или количество элементов запроса превышает лимит
429 Превышен лимит количества запросов
500 При обработке запроса возникла непредвиденная ошибка
502 Сервис временно недоступен
503 Сервис временно отключен
504 Превышен таймаут обращения к сервису, повторите попытку позднее

Также, вместе с телом ответа ошибки, вам могут прийти следующие заголовки (Headers):

  • X-Lognex-Auth - расширенный код ошибки аутентификации

  • X-Lognex-Auth-Message - сообщение об ошибке.

  • X-Lognex-API-Version-Deprecated - дата отключения запрошенной версии API.

  • Location - URL по которому доступен запрашиваемый ресурс (в случае ответа с кодом 301)

Вы можете узнать лимит оставшихся запросов с помощью следующих заголовков

  • X-RateLimit-Limit - количество запросов, которые равномерно можно сделать в течение интервала до появления 429 ошибки

  • X-Lognex-Retry-TimeInterval - интервал в миллисекундах, в течение которого можно сделать эти запросы

  • X-RateLimit-Remaining - Число запросов, которые можно отправить до получения 429 ошибки

  • X-Lognex-Reset - время до сброса ограничения в миллисекундах. Равно нулю, если ограничение не установлено

  • X-Lognex-Retry-After - время до сброса ограничения в миллисекундах.

Все коды ошибок и их описания

1000

  • Сообщение: Элемент URI не является идентификатором

  • Описание: Вероятнее всего вы пытаетесь обратиться к несуществующему ресурсу. Проверьте указанный вами URI, проверьте правильно ли вы указали ключевое слово сущности и полностью ли вы скопировали ID.

1002

  • Сообщение: Неопознанный путь: {путь}

  • Описание: Не удалось определить ресурс, по которому был сделан запрос. Проверьте URI, по которому совершается запрос.

1004

  • Сообщение: Ошибка при формировании результата: {текст ошибки}

  • Описание: При разборе переданного объекта произошла ошибка. Проверьте корректность переданных данных.

1005

  • Сообщение: Неизвестный тип: {тип}

  • Описание: Тип сущности, указанный в URI, не может быть найден. Проверьте корректность ключевого слова.

1007

  • Сообщение: Неизвестное поле: {имя поля}

  • Описание: При обновлении сущности указанное поле не было найдено. Проверьте правильность написания имени поля, а также убедитесь что данное поле присутствует среди атрибутов сущностей этого типа.

1008

  • Сообщение: Ошибка при загрузке объекта с типом ‘{тип}’ и идентификатором ‘{id}’

  • Описание: Не удалось загрузить сущность с данным id. Проверьте корректность id. Убедитесь что сущность с данным id присутствует среди списка сущностей данного типа (возможно сущность с данным id была удалена).

1009

  • Сообщение: Редактирование объектов типа ‘{тип}’ не поддерживается

  • Описание: Сущность которую вы пытаетесь обновить - readonly. Изменение её атрибутов не предусмотрено.

1010

  • Сообщение: Удаление объектов типа ‘{тип}’ не поддерживается

  • Описание: Нельзя удалить сущность данного типа. Проверьте есть ли среди операций данного типа сущностей операция удаления.

1011

  • Сообщение: Создание объектов типа ‘{тип}’ не поддерживается

  • Описание: Нельзя создать сущность данного типа. Проверьте есть ли среди операций данного типа сущностей операция создания.

1012

  • Сообщение: Не указан идентификатор объекта

  • Описание: Ресурс, к которому вы обратились, требует идентификатор объекта.

1014

  • Сообщение: Неверное значение ‘{значение}’ параметра фильтрации ‘{имя параметра}’

  • Описание: Вы указали значение неподдерживаемого типа для данного параметра (например передали int вместо boolean). Возможно ошибка в неправильном формате даты и времени.

1015

  • Сообщение: Указана неверная версия в url: {url}

  • Описание: Проверьте необходимую версию API в url по которому вы делаете запрос. online.moysklad.ru/api/1.x/... Версии API различаются между собой по количеству доступных ресурсов, а также по способу обработки данных и именно поэтому являются важным элементом идентификации того или иного ресурса.

1016

  • Сообщение: Доступ запрещен: у вас нет прав на просмотр данного объекта

  • Описание: Администратор учётной записи ограничил ваши права на просмотр сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1017

  • Сообщение: Доступ запрещен: у вас нет прав на редактирование данного объекта

  • Описание: Администратор учётной записи ограничил ваши права на редактирование сущностей данного типа. Свяжитесь с ним для выяснения подробностей.

1019

  • Сообщение: Чтение поля ‘{имя поля}’ не поддерживается

  • Описание: Невозможно чтение поля данного типа.

1020

  • Сообщение: Родительский объект с типом ‘{тип}’ и идентификатором ‘{id}’ не существует

  • Описание: Неверный id родительской сущности.

1021

  • Сообщение: Объект с типом ‘{тип}’ и идентификатором ‘{id}’ не найден

  • Описание: Не удалось загрузить сущность данного типа с данным id. Проверьте корректность id. Убедитесь что сущность с данным id присутствует среди списка сущностей данного типа (возможно сущность с данным id была удалена)

1022

  • Сообщение: Ошибка при создании объекта

  • Описание: Ошибка в процессе создания сущности данного типа.

1023

  • Сообщение: Ошибка сохранения объекта: дочерний объект с типом ‘{тип}’ и идентификатором ‘{id}’ уже используется и не может быть удален

  • Описание: Невозможно удалить объект во вложенной коллекции т.к. он уже где-то используется. Например, может возникнуть при удалении позиции из документа, по которому есть возврат, в котором присутствует данная позиция.

1024

  • Сообщение: Ошибка сохранения объекта: изменять стандартные объекты запрещено

  • Описание: Вы пытаетесь изменить сущность, которая создаётся по умолчанию в сервисе МойСклад сразу после регистрации учётной записи. Это делать запрещено. (Например изменение стандартных стран и единиц измерения)

1027

  • Сообщение: Запрос не содержит объектов

  • Описание: Body запросов на создание/обновление должно представляться в виде объекта либо массива JSON.

1034

  • Сообщение: Ошибка фильтрации: {текст ошибки}

  • Описание: Ошибка в процессе обработки фильтров. Проверьте переданные фильтры на валидность. Подробнее о параметрах фильтрации вы можете прочесть в соответствующем разделе документации или в документации по сущности, к которой вы пытаетесь применять фильтры.

1035

  • Сообщение: Ошибка фильтрации: неверный формат даты параметра фильтрации

  • Описание: Проверьте значение даты и времени. Оно должно соответствовать формату yyyy-MM-dd HH:mm:ss

1036

  • Сообщение: Ошибка при формировании метаданных

  • Описание Внутренняя ошибка сервиса. Попробуйте повторить запрос.

1038

  • Сообщение: Ошибка в адресе запроса

  • Описание Проверьте, указываете ли вы валидный адрес запроса.

1039

  • Сообщение: Операция {HTTP метод} не поддерживается для данного ресурса

  • Описание Проверьте метод, с которым вы обращаетесь к ресурсу. Убедитесь, что в документации ресурса этот метод описан и его можно применить.

1040

  • Сообщение: Неверно заданы параметры запроса

  • Описание Один или несколько параметров запроса заданы некорректно. Проверьте формат параметров согласно документации.

1044

  • Сообщение: Превышен максимальный размер запроса

  • Описание: Максимальный размер запроса 10 МБ.

1048

  • Сообщение: Превышено ограничение на количество попыток проверки имени и пароля

  • Описание Вы попытались авторизоваться с помощью пары логин-пароль слишком много раз.

1049

  • Сообщение: Превышено ограничение на количество запросов в единицу времени

  • Описание От вас поступает слишком много запросов в единицу времени.

1050

  • Сообщение: Запрос метаданных не поддерживается в posap

  • Описание В posap не поддерживаются запросы на получение метаданных.

1051

  • Сообщение: Тип не совпадает с типом <meta_type> из meta

  • Описание Тип, который вы указали в объекте meta не соответствует типу ресурса, к которому вы делаете запрос.

1052

  • Сообщение: Неверный формат UUID

  • Описание: Проверьте сгенерированные вами UUID на корректность.

1053

  • Сообщение: Чтение объектов типа ‘{тип}’ не поддерживается

  • Описание: Нельзя прочтитать сущность данного типа.

1054

  • Сообщение: Указанный тип {тип сущности} не найден

  • Описание Ресурс для переданного типа не существует.

1055

  • Сообщение: Неизвестное значение {значение} параметра direction

  • Описание Вы передали некорректное значение direction. Можно передать только одно из следующих значений: forward, backward.

1056

  • Сообщение: Ошибка аутентификации: {текст ошибки аутентификации}

  • Описание Проверьте указанные для аутентификации данные. Возможно для данного ресурса требуется другой вид аутентификации.

1057

  • Сообщение: Отсутствует syncid для сущности

  • Описание В posap в ссылках (href) в meta необходимо всегда указывать /syncId/{id} сущности, который должен генерироваться на клиенте.

1060

  • Сообщение: Некорректный тип данных в meta сущности, поле type

  • Описание Тип данных указанный в поле type метаданных сущности не совпадает с ожидаемым типом.

1062

  • Сообщение: Неверное значение заголовка ‘Accept’. Поддерживается только значение ‘application/json;charset=utf-8’

  • Описание Заголовок Accept должен отсутствовать либо иметь значение указанное в тексте ошибки.

1065

  • Сообщение: Ошибка сохранения объекта: объект уже изменен/удален в параллельном запросе

  • Описание Ошибка возникает при попытке изменить объект из нескольких параллельных запросов к API.

1070

  • Сообщение: Ошибка: ваш тарифный план не позволяет вам работать с данным ресурсом

  • Описание На вашем тарифном плане работа с указанным ресурсом недоступна.

1071

  • Сообщение: Превышено ограничение на количество попыток регистрации

  • Описание Вы попытались зарегистрироваться слишком много раз

1072

  • Сообщение: Превышено ограничение на количество регистраций с указанного адреса

  • Описание Вы попытались зарегистрироваться слишком много раз

1073

  • Сообщение: Превышено ограничение на одновременное количество запросов

  • Описание От вас поступает слишком много параллельных запросов в единицу времени.

1074

  • Сообщение: Сервис временно недоступен, ведутся технические работы

  • Описание На сервере проводятся технические работы.

1999

  • Сообщение: Неизвестная ошибка

  • Описание Произошла непредвиденная ошибка. Пожалуйста, обратитесь в поддержку сервиса МойСклад подробно изложив условия при которых эта ошибка произошла.

Ошибки формата

2000

  • Сообщение: Ошибка формата: отсутствует начало объекта

  • Описание: В данном месте ожидалось начало объекта. Проверьте тело запроса.

2001

  • Сообщение: Ошибка формата: входящий запрос не соответствует формату JSON

  • Описание: Данные должны быть отправлены в формате JSON. Если это так, а ошибка всё-таки возникает - попробуйте добавить Header Content-Type со значением application/json.

2002

  • Сообщение: Ошибка формата: неименованное внутреннее поле типа массив

  • Описание: Проверьте указали ли вы наименование поля типа массив. Возможно присутствуют лишние открывающиеся/закрывающиеся скобки в теле запроса.

2003

  • Сообщение: Ошибка формата: неименованное внутреннее поле типа объект

  • Описание: Проверьте указали ли вы наименование поля типа “объект”. Возможно присутствуют лишние открывающиеся/закрывающиеся скобки в теле запроса.

2004

  • Сообщение: Ошибка формата: вложенные массивы недопустимы

  • Описание: В рамках JSON API не обрабатываются массивы массивов. Проверьте тело запроса на корректность.

2005

  • Сообщение: Ошибка формата: входящий JSON должен начинаться либо с объекта, либо с массива

  • Описание: Отсутствует открывающаяся фигурная/квадратная скобка в начале тела запроса.

2006

  • Сообщение: Ошибка формата: слишком большая вложенность объектов

  • Описание: Максимальная глубина вложенности в JSON API - 10. Скорректируйте тело запроса и убедитесь, что это ограничение не нарушается.

2007

  • Сообщение: Ошибка формата: слишком большое число вложенных объектов

  • Описание: В JSON API в массиве может содержаться не более 1000 объектов.

2008

  • Сообщение: Ошибка формата: запрос на шаблон не должен содержать массив

  • Описание: С помощью запроса по ресурсу {entity_name}/new можно создать только 1 шаблон. Передача массива значений не поддерживается.

2009

  • Сообщение: Ошибка формата: запрос на создание/обновление одной сущности не должен содержать массив

  • Описание: При обновлении отдельной сущности подразумевается, что в теле запроса будет передано её новое представление (одно). В теле запроса должен быть один корневой объект.

2010

  • Сообщение: Ошибка формата: отсутствует href для meta поля ‘{доп. сообщение}’

  • Описание: В переданном объекте метаданных отсутствует поле href. Проверьте тело запроса.

2012

  • Сообщение: Ошибка формата: неизвестный type для meta поля ‘{доп. сообщение}’

  • Описание: В переданном объекте метаданных указан неизвестный тип. Проверьте тело запроса. Возможно вы указываете неверное ключевое слово для сущности. Проверьте документацию по данной сущности и убедитесь в правильности передаваемого type.

2013

  • Сообщение: Ошибка формата: неправильное значение href для meta поля ‘{доп. сообщение}’

  • Описание: Переданный href указывает на несуществующий объект. Убедитесь в корректности ссылки. Ошибка может быть в версии API, типе ресурса (entity/pos/report), ключевом слове сущности/(отчёта), id сущности.

2014

  • Сообщение: Ошибка формата: отсутствует meta для поля ‘{имя поля}’

  • Описание: Для полей типа метаданных (ссылок на другие связанные объекты) необходимо значение в виде объекта, содержащего meta.

2015

  • Сообщение: Ошибка формата: отсутствует id для поля ‘{имя поля}’

  • Описание: При передаче вложенных сущностей в виде полей необходимо указывать id этих сущностей.

2016

  • Сообщение: Ошибка формата: значение поля ‘{имя поля}’ не соответствует типу {тип поля}

  • Описание: Для указанного поле передано значение неверного типа. Исправьте тело запроса.

2017

  • Сообщение: Ошибка формата: неизвестная ошибка

  • Описание: Не удалось однозначно классифицировать ошибку. Убедитесь что формат передаваемых вами данных соответствует требуемому. Посмотрите примеры запросов в документации по используемой вами сущности.

2018

  • Сообщение: Ошибка формата: отсутствует поле для meta

  • Описание: Вы не указали обязательное поле объекта meta.

2019

  • Сообщение: Ошибка формата: Поле не совпадает с указанным в href для meta

  • Описание: В объекте meta нет соответствия между указанным полем и информацией в ссылке (href). Проверьте, совпадают ли id, idType и type в объекте meta и в ссылке (href) meta.

2020

  • Сообщение: Ошибка формата: href для meta должен ссылаться на сущность, /entity/

  • Описание: В ссылке (href) объекта meta можно ссылаться только на ресурсы из posap /entity/.

2025

  • Сообщение: Ошибка формата: Ошибка формата: значение <заголовок|параметр|поле> ‘<наименование>’ не соответствует формату даты ‘<формат даты>’

  • Описание: Переданное значение даты не соответствует формату даты

2029

  • Сообщение: Ошибка формата: неверное значение ‘<значение>’ поля ‘<имя поля>’. Допустимые значения: <множество значений>

  • Описание: В получаемом объекте содержится поле, которое не попадает во множество допустимых значений.

Общие ошибки валидации

3000

  • Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не может быть пустым или отсутствовать

  • Описание: Необходимое поле не может содержать пустого значения или отсутствовать. Все необходимые поля можно посмотреть в документации по сущности, с которой вы работаете, под заголовком “Атрибуты сущности”. Такие поля помечены как Необходимое.

3001

  • Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не может быть изменено

  • Описание: Вы пытаетесь изменить поле являющееся полем только для чтения. Все read-only поля можно посмотреть в документации по сущности, с которой вы работаете, под заголовком “Атрибуты сущности”. Такие поля помечены как Только для чтения.

3002

  • Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не может иметь отрицательное значение

  • Описание: Данное поле принимает только числовые значения больше либо равные нулю.

3003

  • Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ должно быть больше нуля

  • Описание: Данное поле принимает только числовые значения больше нуля.

3004

  • Сообщение: Ошибка сохранения объекта: поле ‘{имя поля}’ не соответствует полю связанного объекта

  • Описание: Поле возврата не соответствует полю документа-основания. Невозможно изменить значения полей agent, currency, vatIncluded в возвратах на несоответствующие значениям этих же полей в документе-основании.

3005

  • Сообщение: Ошибка сохранения объекта: неверное значение ‘{значение}’ поля ‘{имя поля}’. Допустимые значения: {список значений}

  • Описание: Вы пытаетесь присвоить несуществующее значение полю типа “перечисление”(enum). Проверить все возможные значения этого поля вы можете в документации по данной сущности в разделе “Атрибуты сущности”.

3006

  • Сообщение: Ошибка сохранения объекта: нарушено ограничение уникальности параметра ‘{имя параметра}’

  • Описание: У указанного поля/параметра должно быть уникальное значение в системе. Например, если включена проверка на уникальность номеров операций, name у разных документов не может быть одинаковым.

3007

  • Сообщение: Ошибка валидации сохраняемого объекта: ‘{объект}’

  • Описание: Ошибка при обмене. Проверьте, соблюдает ли все условия передаваемый вами объект.

3008

  • Сообщение: Ошибка сохранения объекта: значение поля ‘{имя поля}’ превышает максимально допустимое значение

  • Описание: Значение числового поля превышает максимально допустимое значение: 9 999 999 999.

3011

  • Сообщение: Ошибка валидации штрихкода: невозможно добавить к сущности штрихкод длиной более 255 символов

  • Описание: Исправьте длину штрихкода и попробуйте повторить запрос.

3030

  • Сообщение: Ошибка валидации заголовка ‘{название заголовка}’: {описание ошибки}

  • Описание: Было передано некорректное значение в заголовке.

3037

  • Сообщение: Невозможно отправить запрос на удаление аккаунта. Нет адреса электронной почты владельца аккаунта или адрес некорректный. Обратитесь к владельцу аккаунта

  • Описание: У заданного аккаунта владелец аккаунт имеет пустой или некорректный электронный адрес.

Точки продаж

4000

  • Сообщение: Указанная точка продаж не активна

  • Описание: Для выполнения операции необходимо активировать точку продаж.

Розничные смены (POS)

12003

  • Сообщение: Ошибка закрытия розничной смены: розничная смена находится в корзине

  • Описание: Смена с указанным id находится в корзине. Проверьте правильность указанного вами id смены.

12006

  • Сообщение: Ошибка открытия розничной смены: параметр ‘retailShift’ отсутствует или имеет неверный формат

  • Описание: Убедитесь в наличии параметра retailShift.

12007

  • Сообщение: Ошибка закрытия розничной смены: параметр ‘retailShift’ отсутствует или имеет неверный формат

  • Описание: В теле запроса должно присутствовать поле retailShift (в camel-case) типа объект, содержащее в себе meta с ссылкой, содержащей syncId открываемой смены.

12008

  • Сообщение: Ошибка открытия розничной смены: параметр ‘name’ отсутствует

  • Описание: В теле запроса должно присутствовать поле name (номер смены) типа строка.

12009

  • Сообщение: Ошибка открытия розничной смены: параметр ‘openmoment’ отсутствует

  • Описание: В теле запроса должно присутствовать поле openmoment (дата-время открытия) типа строка в формате дата-время.

12010

  • Сообщение: Ошибка закрытия розничной смены: параметр ‘closemoment’ отсутствует

  • Описание: В теле запроса должно присутствовать поле closemoment (дата-время закрытия) типа строка в формате дата-время.

12012

  • Сообщение: Розничная смена не существует

  • Описание: Смена которую вы пытаетесь закрыть не существует. Убедитесь что указываете верный syncId смены.

12013

  • Сообщение: Ошибка аутентификации. Пользователь {user} не является кассиром на точке продаж «{retailstore}»

  • Описание: Для указанной точки продаж пользователь не является кассиром. Указать кассира можно в настройках точки продаж.

12014

  • Сообщение: Непредвиденная ошибка сохранения токена

  • Описание: Попробуйте осуществить запрос на получение токена ещё раз.

12015

  • Сообщение: Ошибка получения токена: не найдена точка продаж

  • Описание: Не найдено точки продаж с указанным id.

12016

  • Сообщение: Пользователь-кассир деактивирован. Обратитесь к администратору аккаунта.

  • Описание: Вы пытаетесь аутентифицироваться как неактивный пользователь. Следует обратиться к администратору аккаунта.

12017

  • Сообщение: Неправильный или просроченный ключ доступа

  • Описание: Срок действия ключа доступа истёк или же сам переданный ключ не корректен. Уточните вводимые данные.

12018

  • Сообщение: Допустимо использование сессии только для авторизованной точки продаж

  • Описание: Точка продаж должна быть привязана к токену. О том как это сделать вы можете прочитать тут.

12021

  • Сообщение: Ошибка закрытия розничной смены: нельзя закрыть смену другой точки продаж

  • Описание: Смена, которую вы пытаетесь закрыть, принадлежит другой точке продаж. Убедитесь в правильности token, который вы используете для аутентификации, а также в правильности syncId смены.

12022

  • Сообщение: Указанный пользователь не является кассиром ни на одной точке продаж

  • Описание: Только кассир на активной точке продаж может привязать точку продаж и получить токен. Указать кассира можно в настройках точки продаж.

12023

  • Сообщение: Нельзя создать документ в рамках розничной смены, находящейся в корзине

  • Описание: Смена с указанным id находится в корзине. Проверьте правильность указанного вами id смены.

12024

  • Сообщение: Ошибка закрытия розничной смены: непредвиденная ошибка создания (входящего платежа|ПКО)

  • Описание Ошибка в процессе создания входящего платежа или ПКО во время закрытия розничной смены.

12025

  • Сообщение: Ошибка аутентификации: Неправильный пароль или имя пользователя

  • Описание Ошибка в процессе аутентификации.

Товары

16000

  • Сообщение: Ошибка сохранения товара: свойства алкогольной продукции не могут быть отрицательными

  • Описание: Алкогольные поля “код алкогольной продукции”, “крепость” и “объём” должны принимать значение строго большее 0.

16001

  • Сообщение: Ошибка сохранения товара: весовой товар не может использовать учет по серийным номерам

  • Описание: Товар не может одновременно быть весовым и использовать учёт по серийным номерам. Это - взаимоисключающие признаки.

16002

  • Сообщение: Ошибка сохранения товара: нельзя отключить серийный учёт

  • Описание: Если серийный учет однажды включен, то его уже нельзя отключить. В ином случае вы можете создать новый товар.

16003

  • Сообщение: Ошибка сохранения товара: у изображения отсутствует контент

  • Описание: При передаче изображение в составе товара в запросе на создание товара необходимо указывать поле content

16004

  • Сообщение: Ошибка сохранения товара: невозможно преобразовать поле content в изображение

  • Описание: Содержимым поля content должно быть изображение закодированное в формате base64 с расширением jpg или png.

16005

  • Сообщение: Ошибка сохранения товара: Недостаточно места в хранилище.

  • Описание: Место в хранилище, выделенное для вашей учётной записи закончилось.

16006

  • Сообщение: Ошибка сохранения товара: размер изображения превышает максимально допустимый(3 мб)

  • Описание: Попробуйте уменьшить размер изображения.

16008

  • Сообщение: Ошибка сохранения товара: для использования упаковок нужно указать единицу измерения товара

  • Описание: Для использования упаковок должна быть задана единица измерения товара

16010

  • Сообщение: Ошибка сохранения товара: если указано, что товар облагается налогом, то необходимо заполнить поле vat. Иначе vatEnabled для товара должен иметь значение false

  • Описание: При передаче поля vatEnabled = true для товара нужно указывать также значение НДС.

16011

  • Сообщение: Ошибка сохранения товара: разливной товар не может учитываться по серийным номерам.

  • Описание: Товар не может быть одновременно на разлив и с учетом по серийным номерам.

16012

  • Сообщение: Ошибка сохранения товара: товар не может быть разливным и весовым одновременно.

  • Описание: Товар не может быть одновременно весовым и на разлив.

16013

  • Сообщение: Ошибка сохранения товара: весовой товар не может иметь признак средства индивидуальной защиты.

  • Описание: Товар не может быть одновременно на разлив и иметь признак средства индивидуальной защиты.

16014

  • Сообщение: Ошибка сохранения товара: разливной товар не может иметь признак средства индивидуальной защиты.

  • Описание: Разливной товар не может иметь признак средства индивидуальной защиты.

16015

  • Сообщение: Ошибка сохранения товара: неверно указан тип маркировки «{тип маркировки}» для разливного товара.

  • Описание: Разливной товар может сочетаться только с типами маркировки MILK, PERFUMERY, NOT_TRACKED.

16103

  • Сообщение: Ошибка сохранения: маркированный товар не может учитываться по серийным номерам.

  • Описание: Маркированный товар не может учитываться по серийным номерам.

16104

  • Сообщение: Ошибка сохранения товара: маркированный товар не может быть алкогольным.

  • Описание: Маркированный товар не может быть алкогольным.

16105

  • Сообщение: Ошибка сохранения товара: Ошибка сохранения: маркированный товар не может быть весовым.

  • Описание: Весовой товар может сочетаться только с типами маркировки MILK, NOT_TRACKED.

16113

  • Сообщение: * Ошибка сохранения товара: маркированный товар не может быть средством индивидуальной защиты.*

  • Описание: Маркированный товар не может быть средством индивидуальной защиты.

Документы

17002

  • Сообщение: Ошибка сохранения позиции документа: серийный номер не может быть пустым

  • Описание: Серийный номер не может быть пустой строкой.

17003

  • Сообщение: Ошибка сохранения позиции документа: количество зарезрвированных товаров не может превышать общее количество

  • Описание: Количество зарезервированного товара позиции документа не может превышать общее количество товара по документу.

17004

  • Сообщение: Ошибка сохранения позиции документа: количество товаров в ожидании не может превышать общее количество

  • Описание: Количество ожидаемого товара позиции документа не может превышать общее количество товара по документу.

17005

  • Сообщение: Ошибка сохранения связанного документа: отсутствует ссылка на документ-основание

  • Описание: При сохранении связанного документа необходима ссылка на документ-основание (например при сохранении возврата необходима ссылка на продажу).

17007

  • Сообщение: Ошибка сохранения позиции документа: НДС не может быть больше 100

  • Описание: Процент НДС может принимать значения от 0 до 100.

17008

  • Сообщение: Ошибка сохранения позиции документа: скидка не может быть больше 100

  • Описание: Процент скидки может принимать значения от 0 до 100.

17017

  • Сообщение: Ошибка сохранения документа: количество переданных серийных номеров не соответствует количеству в позиции

  • Описание: Поле позиции quantity должно соответствовать размеру коллекции sn.

17021

  • Сообщение: Ошибка сохранения позиции документа: если указано, что позиция облагается налогом, то необходимо заполнить поле vat. Иначе vatEnabled для позиции должен иметь значение false

  • Описание: При передаче поля vatEnabled = true в позиции нужно указывать также значение НДС.

Продажи

18000

  • Сообщение: Ошибка сохранения продажи: сумма ‘cashSum’, ‘noCashSum’, ‘qrSum’, ‘prepaymentCashSum’, ‘prepaymentNoCashSum’ и ‘prepaymentQrSum’ не соответствует сумме по документу

  • Описание: Сумма полей cashSum, noCashSum, qrSum, prepaymentCashSum, prepaymentNoCashSum, prepaymentQrSum должна быть равна значению поля sum или отличаться менее чем на 10 единиц. В случае создания документа и указании вышеупомянутых полей в теле запроса, ответственность за подсчёт sum ложится на пользователя. sum считается как общая сумма по всем позициям документа. Допускается расхождение на 10 (учет идёт в копейках).

18003

  • Сообщение: Ошибка сохранения продажи: нельзя указывать баллы к начислению или списанию без указания бонусной программы

  • Описание: При заполнении любого из полей bonusValueToEarn, bonusValueToSpend, поле bonusProgram становится обязательным для заполнения.

18005

  • Сообщение: В случае заполненного поля ‘qrSum’ поля ‘cashSum’, ‘noCashSum’, ‘prepaymentCashSum’ и ‘prepaymentNoCashSum’ должны быть пустыми

  • Описание: Смешанная оплата по QR-коду и карте или по QR-коду и наличными запрещена

18006

  • Сообщение: В случае заполненного поля ‘prepaymentQrSum’ поля ‘cashSum’, ‘noCashSum’, ‘prepaymentCashSum’ и ‘prepaymentNoCashSum’ должны быть пустыми

  • Описание: В случае предоплаты по QR-коду оплата возможна только по QR-коду

Возвраты

19003

  • Сообщение: Ошибка сохранения розничного возврата: возврат возможен только по QR-коду

  • Описание: Возникает в случае, если продажа была осуществлена по QR-коду, а возврат осуществляется за наличные или по карте. При создании такого возврата поля ‘cashSum’ и ‘noCashSum’ должны отсутствовать

19004

  • Сообщение: Ошибка сохранения розничного возврата: возврат по QR-коду поддержан только для операций, оплаченных по QR-коду

  • Описание: Возникает в случае, если продажа была осуществлена за наличные или по карте, а возврат осуществляется по QR-коду. При создании такого возврата поле ‘qrSum’ должно отсутствовать

Серийные номера

45000

  • Сообщение: Ошибка формата: количество переданных серийных номеров не соответствует количеству в позиции

  • Описание: Поле позиции quantity должно соответствовать размеру коллекции sn.

45001

  • Сообщение: Ошибка формата: указаны серийные номера для позиции {id}, по которой не ведётся серийный учет

  • Описание: Для указанной позиции нельзя вести учет по товарам и передавать коллекцию sn для расчета.

46000

  • Сообщение: Ошибка вызова внешней системы лояльности

  • Описание: При вызове внешней системы лояльности возникла ошибка.

46001

  • Сообщение: Отсутствует syncid для сущности ‘counterparty’

  • Описание: В данном методе предполагается, что у сущности counterparty должно быть непустое свойство syncid

46002

  • Сообщение: Невозможно рассчитать чек

  • Описание: Во время работы метода возникла ошибка, которая не позволяет выполнить пересчет. Может возникать, как последствие ошибки при вызове внешней системы (системы лояльности)

Тарифные ограничения

47000

  • Сообщение: Тарифное ограничение: {описание ограничения}

  • Описание: Сработало тарифное ограничение для текущего тарифа.

Предоплаты

48000

  • Сообщение: Сумма предоплаты должна быть положительным числом.

  • Описание: Сумма предоплаты складывается из полей cashSum и noCashSum. Проверьте, чтобы сумма этих полей была > 0.

48001

  • Сообщение: В предоплате должна быть хотя бы одна позиция.

  • Описание: Невозможно создать предоплату без позиций.

48002

  • Сообщение: Сумма предоплаты не может превышать сумму по позициям

  • Описание: Сумма предоплаты не может быть больше суммарной стоимости всех позиций.

48003

  • Сообщение: Невозможно создать предоплату от розничного покупателя. Должен быть выбран “реальный” контрагент.

  • Описание: Предоплата не может быть создана на контрагента “Розничный покупатель”.

48004

  • Сообщение: Невозможно создать предоплату по заказу с неположительной суммой

  • Описание: Сумма заказа, по которой создаётся предоплата, должна быть >= 0.

48005

  • Сообщение: Невозможно создать предоплату по заказу у которого нет хотя бы одной позиции

  • Описание: В заказе, по которому создаётся предоплата, должна быть хотя бы одна позиция.

48006

  • Сообщение: Невозможно создать предоплату по полностью оплаченному заказу

  • Описание: Сумма платежей и предоплат по переданному заказу >= сумме самого заказа. Предоплата по такому заказу не имеет смысла.

Возвраты предоплат

49000

  • Сообщение: Сумма возврата предоплаты должна быть положительным числом.

  • Описание: Сумма возврата предоплаты складывается из полей cashSum и noCashSum. Проверьте, чтобы сумма этих полей была > 0.

49001

  • Сообщение: В возврате предоплаты должна быть хотя бы одна позиция.

  • Описание: Невозможно создать возврат предоплаты без позиций.

49002

  • Сообщение: Сумма возврата предоплаты не может превышать сумму по позициям

  • Описание: Сумма возврата предоплаты не может быть больше суммарной стоимости всех позиций.

49003

  • Сообщение: Невозможно сохранить возврат предоплаты: сумма возвратов превышает сумму предоплаты.

  • Описание: Невозможно сохранить возврат предоплаты, т.к. в противном случае сумма возвратов превысит сумму предоплаты.

Метаданные

Структура метаданных в posap:

Метаданные коллекций:

  • href - ссылка

  • mediaType - MIME тип

  • size - размер выборки

  • limit - макс. количество объектов в выборке

  • offsetId - id элемента, после которого начинается текущая страница сущностей

  • direction - направление листания. Одно из значений [forward, backward]

  • previousHref - Ссылка на предыдущую страницу (отображается только когда указан offsetId не по умолчанию)

  • nextHref - Ссылка на следующую страницу (отображается только когда указан offsetId не по умолчанию)

Метаданные объектов

  • href - ссылка на сущность

  • mediaType - MIME тип

  • type - тип сущности

  • id - id сущности

  • idType - тип id. Одно из значений [native, sync]

Формат даты и времени в миллисекундах

В POS API можно получать поля типа дата-время (момент времени) в формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС.ммм. Для этого нужно добавить специальный заголовок к запросу:
X-Lognex-Format-Millisecond со значением true.

Вывод JSON с отступами

В POS API можно получать ответы от сервера в виде pretty-print JSON (JSON с отступами вместо JSON в одну строку). Для этого нужно добавить специальный заголовок к запросу:
Lognex-Pretty-Print-JSON со значением true.

Заголовок временного отключения Веб-хуков

Через JSON API или POS API при запросах можно отключить уведомления вебхуков в контексте данного запроса.
Для этого нужно указать заголовок X-Lognex-WebHook-Disable с произвольным значением.

Стандартный розничный покупатель

На учётной записи пользователя есть контрагент, использующийся как контрагент для розничных продаж. По умолчанию он назван “Розничный покупатель”. Если через POS API создать продажу, не указывая при этом поле agent, контрагентом такой продажи автоматически станет “Розничный покупатель”.

Сценарий работы

Сценарий работы с POS API состоит из нескольких шагов:

  • Получение токена для точки продаж

  • Загрузка необходимых для работы данных (настройки точки продаж, справочник товаров и услуг, справочник контрагентов)

  • Открытие розничной смены

  • Совершение операций (кассовые внесения и выплаты, продажи, возвраты по продажам)

  • Закрытие розничной смены

Для получения токена для точки продаж необходимо воспользоваться двумя административными ресурсами:

  • Ресурсом для получения списка точек продаж

  • Ресурсом для получения токена для выбранной точки продаж

Важное отличие административных ресурсов в том, что авторизация на них происходит с помощью пары логин-пароль от учётной записи сервиса МойСклад (Basic Auth). На всех остальных ресурсах необходима авторизация по полученному токену для точки продаж.
После получения токена для авторизации можно начинать работу от лица POS терминала, открывать и закрывать смены, запрашивать данные и проводить операции.

Ограничения на доступ к данным

При работе с POS API убедитесь:

  • Что активна текущая точка продаж, для которой открываются смены, создаются операции, и, в рамках которой посылаются запросы.

  • Что пользователь, от имени которого посылаются запросы, авторизован соответствующим для данного ресурса способом (способ авторизации указан для каждого ресурса POS API в секции “Авторизация”), и, в случае авторизации по token для точки продаж, он является активным пользователем и кассиром на данной точке продаж.

Пример

Ниже, в качестве примера, описан один из возможных сценариев работы с POS API, состоящий из следующих шагов:

  • Получение списка точек продаж

  • Получение токена для точки продаж

  • Загрузка настроек точки продаж

  • Открытие смены

  • Загрузка списка товаров и услуг

  • Создание продажи

  • Закрытие смены

Получить точки продаж

Для начала работы нам нужно выбрать точку, с которой мы будем осуществлять розничные операции. Для этого запросим список точек продаж.

GET https://online.moysklad.ru/api/posap/1.0/admin/retailstore
Responses200

Успешный запрос. Результат - JSON представление списка точек продаж.

Headers
Content-Type: application/json
Authorization: Basic YWRtaW5AcmVxd3k6MTIzMTIz
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/admin/retailstore",
    "mediaType": "application/json",
    "size": 1,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailstore/5d4d2ca2-7b1d-11e6-8a84-bae500000060",
        "mediaType": "application/json",
        "type": "retailstore",
        "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
        "idType": "native"
      },
      "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
      "version": 2,
      "updated": "2016-09-21 19:27:45",
      "name": "Точка продаж",
      "externalCode": "W0M-XxXYjPZJjA1cT3RTL2",
      "controlShippingStock": false,
      "controlCashierChoice": false,
      "discountEnable": true,
      "discountMaxPercent": 100,
      "priceType": "Цена продажи",
      "authTokenAttached": true,
      "cashiers": {
        "rows": [
          {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/employee/a4f36276-7b5a-11e6-8a84-bae500000004",
              "mediaType": "application/json",
              "type": "employee",
              "id": "a4f36276-7b5a-11e6-8a84-bae500000004",
              "idType": "native"
            },
            "uid": "cashier@myorg",
            "firstName": "Иван",
            "middleName": "Иванович",
            "lastName": "Иванов",
            "email": "ivanov@myorg.ru"
          }
        ]
      },
      "organization": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/organization/5d0f5e3e-7b1d-11e6-8a84-bae500000051",
          "mediaType": "application/json",
          "type": "organization",
          "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
          "idType": "native"
        },
        "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
        "version": 5,
        "updated": "2016-09-21 14:30:43",
        "name": "myorg",
        "description": "Моя организация",
        "code": "1234",
        "externalCode": "PW55m0xUiG1pAlGJv73Sd2",
        "companyType": "legal",
        "legalTitle": "ООО Иванов",
        "legalAddress": "г Москва, ул Гашека, д 12 к 1",
        "actualAddress": "г Москва, ул Вавилова д 19 3/4",
        "inn": "7714045520",
        "kpp": "775001001",
        "ogrn": "1027700042413",
        "okpo": "121351253251",
        "email": "myorg@orgmy.su",
        "phone": "346243637247",
        "fax": "32472377432524",
        "isEgaisEnable": true,
        "fsrarId": "the id for fr",
        "payerVat": true,
        "utmUrl": "url.coms"
      },
      "store": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/store/5d1fa036-7b1d-11e6-8a84-bae500000053",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "5d1fa036-7b1d-11e6-8a84-bae500000053",
          "idType": "native"
        },
        "pathName": "",
        "address": "г Москва ул Милашенкова д 2"
      },
      "acquire": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
          "idType": "native"
        }
      },
      "egaisEnabled": false,
      "frNumber": "",
      "returnFromClosedShiftEnabled": false,
      "alwaysPrintCheck": false,
      "ofdEnabled": false,
      "allowCustomPrice": false,
      "isExternalCustomers": false,
      "sendMarksForCheck": false
    }
  ]
}

Получить точки продаж
GET/admin/retailstore

Запрос списка точек продаж. Basic авторизация с помощью пары логин:пароль закодированных в BASE64.
В ответ получим список точек продаж.

Назначить токен для точки продаж

После того как мы выбрали точку продаж нужно получить для неё токен авторизации. Используем id нашей точки продаж (5d4d2ca2-7b1d-11e6-8a84-bae500000060). И получаем необходимый нам токен.

POST https://online.moysklad.ru/api/posap/1.0/admin/attach/5d4d2ca2-7b1d-11e6-8a84-bae500000060
Responses201

Успешный запрос. Результат - токен для последующей аутентификации на данной точке продаж.

Headers
Content-Type: application/json
Authorization: Basic YWRtaW5AcmVxd3k6MTIzMTIz
BodyСкрытьПоказать
{
  "token": "6ab89be1ae6ff147753335ee8da948e42612233b",
  "uid": "kassir@321"
}

Назначить токен для точки продаж
POST/admin/attach/{id}

URI Параметры
СкрытьПоказать
id
string (required) Example: 5d4d2ca2-7b1d-11e6-8a84-bae500000060

id точки продаж, которой назначается token

Настройки точки продаж

Теперь авторизуемся по полученному токену и запросим настройки точки продаж.

GET https://online.moysklad.ru/api/posap/1.0/settings/retailstore/
Responses200

Успешный запрос. Результат - JSON представление настроек точки продаж.

Headers
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147753335ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: example@admin
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailstore/5d4d2ca2-7b1d-11e6-8a84-bae500000060",
    "mediaType": "application/json",
    "type": "retailstore",
    "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
    "idType": "native"
  },
  "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
  "version": 2,
  "updated": "2016-09-21 19:27:45",
  "name": "Точка продаж",
  "externalCode": "W0M-XxXYjPZJjA1cT3RTL2",
  "controlShippingStock": true,
  "onlyInStock": false,
  "controlCashierChoice": false,
  "discountEnable": true,
  "discountMaxPercent": 100,
  "priceType": "Цена продажи",
  "authTokenAttached": true,
  "requiredFio": false,
  "requiredPhone": true,
  "requiredEmail": false,
  "requiredBirthdate": false,
  "requiredSex": false,
  "requiredDiscountCardNumber": false,
  "allowDeleteReceiptPositions": true,
  "syncAgents": true,
  "marksCheckMode": "CORRECT_MARKS_ONLY",
  "sendMarksToChestnyZnakOnCloud": false,
  "testChestnyZnakMode": true,
  "cashiers": {
    "rows": [
      {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/employee/a4f36276-7b5a-11e6-8a84-bae500000004",
          "mediaType": "application/json",
          "type": "employee",
          "id": "a4f36276-7b5a-11e6-8a84-bae500000004",
          "idType": "native"
        },
        "uid": "cashier@myorg",
        "firstName": "Иван",
        "middleName": "Иванович",
        "lastName": "Иванов",
        "image": {
          "href": "http://online.moysklad.ru/api/posap/1.0/download/35629a98-d029-11e7-0532-9eed00000001",
          "miniature": "http://online.moysklad.ru/api/posap/1.0/download/35629a98-d029-11e7-0532-9eed00000001?miniature=true",
          "tiny": "http://online.moysklad.ru/app/download/3626405c-d029-11e7-0532-9eed00000002/t.png"
        },
        "inn": "222490425273",
        "position": "position",
        "email": "ivanov@myorg.ru"
      }
    ]
  },
  "organization": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/organization/5d0f5e3e-7b1d-11e6-8a84-bae500000051",
      "mediaType": "application/json",
      "type": "organization",
      "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
      "idType": "native"
    },
    "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
    "version": 5,
    "updated": "2016-09-21 14:30:43",
    "name": "myorg",
    "description": "Страховое публичное акционерное общество «РЕСО-Гарантия»",
    "code": "1234",
    "externalCode": "PW55m0xUiG1pAlGJv73Sd2",
    "companyType": "legal",
    "legalTitle": "СТРАХОВОЕ ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"РЕСО-ГАРАНТИЯ\"",
    "legalAddress": "г Москва, ул Гашека, д 12 к 1",
    "actualAddress": "г Москва, ул Вавилова д 19",
    "inn": "7710045520",
    "kpp": "775001001",
    "ogrn": "1027700042413",
    "okpo": "121351253251",
    "email": "myorg@orgmy.su",
    "phone": "346243637247",
    "fax": "32472377432524",
    "isEgaisEnable": true,
    "fsrarId": "the id for fr",
    "payerVat": true,
    "utmUrl": "url.coms"
  },
  "store": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/store/5d1fa036-7b1d-11e6-8a84-bae500000053",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "5d1fa036-7b1d-11e6-8a84-bae500000053",
      "idType": "native"
    },
    "name": "Основной склад",
    "pathName": "",
    "address": "г Москва ул Милашенкова д 2"
  },
  "acquire": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "idType": "native"
    }
  },
  "lastOperationNames": [
    {
      "entity": "retaildemand",
      "name": "03211312",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retaildrawercashin",
      "name": "00001",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retaildrawercashout",
      "name": "00001",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retailsalesreturn",
      "name": "0002199921",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retailshift",
      "name": "042777001",
      "moment": "2016-10-07 15:50:14"
    }
  ],
  "egaisEnabled": false,
  "frNumber": "",
  "returnFromClosedShiftEnabled": false,
  "alwaysPrintCheck": false,
  "issueOrders": false,
  "sellReserves": false,
  "ofdEnabled": false,
  "allowCustomPrice": false,
  "cash": 10050,
  "createPaymentInOnRetailShiftClosing": true,
  "createCashInOnRetailShiftClosing": false,
  "allowCreateProducts": true,
  "enableReturnsWithNoReason": true,
  "isOnlineDiscount": false,
  "isExternalCustomers": false,
  "isPhonePriority": true,
  "reservePrepaidGoods": false,
  "receiptTemplate": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/receipttemplate/4636cc33-d372-11e8-ac16-000900000001",
      "mediaType": "application/json",
      "type": "receipttemplate",
      "id": "4636cc33-d372-11e8-ac16-000900000001",
      "idType": "native"
    },
    "header": "АКЦИЯ: 6 ЗА 5. ПОДРОБНЕЕ ЧИТАЙТЕ В НИЖНЕЙ ЧАСТИ ЧЕКА",
    "footer": "КУПИТЕ 5 КОФЕ И ПОЛУЧИТЕ 6-й В ПОДАРОК, ПРЕДЪЯВИВ ЭТОТ ЧЕК"
  },
  "environment": {
    "device": "RetailStorePc",
    "os": "Linux",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.1"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    }
  },
  "state": {
    "sync": {
      "message": "Ошибка синхронизации, необходимо войти повторно",
      "lastAttempMoment": "2016-09-06 21:41:00"
    },
    "lastCheckMoment": "2018-06-13 16:18:00",
    "fiscalMemory": {
      "error": {
        "code": "1003",
        "message": "Критическая ошибка"
      },
      "notSendDocCount": 25,
      "notSendFirstDocMoment": "2016-09-06 21:41:00"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    }
  },
  "qrPayEnabled": true,
  "qrAcquire": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "idType": "native"
    }
  },
  "enableNotMRCTobaccoSale": false,
  "tobaccoMrcControlType": "SAME_PRICE",
  "markingSellingMode": "CORRECT_MARKS_ONLY",
  "sendMarksForCheck": false
}

Настройки точки продаж
GET/settings/retailstore/

Открытие смены

Перейдём непосредственно к работе. Для того, чтобы начать создавать продажи нужно открыть смену.

PUT https://online.moysklad.ru/api/posap/1.0/rpc/openshift/
RequestsПример

Пример запроса на открытие смены.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147753335ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: example@admin
BodyСкрытьПоказать
{
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/388bd178-800c-11e6-8a84-bae5022000a2"
    }
  },
  "name": "0001",
  "openmoment": "2016-09-06 21:41:46"
}
Responses204
This response has no content.

Открытие смены
PUT/rpc/openshift/

Для открытия смены нам потребуется syncId. Нужно сгенерировать его самому (на клиенте) и отправить на сервер в запросе на открытие смены.

Загрузка товаров

Для создания продаж потребуется справочник товаров и услуг. Самое время его загрузить.

GET https://online.moysklad.ru/api/posap/1.0/entity/assortment
Responses200

Успешный запрос. Результат - JSON представление ассортимента товаров.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147753335ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: example@admin
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/assortment",
    "mediaType": "application/json",
    "size": 7,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/446901e7-7c12-11e6-8a84-bae500000068",
        "mediaType": "application/json",
        "type": "product",
        "id": "446901e7-7c12-11e6-8a84-bae500000068",
        "idType": "native"
      },
      "id": "446901e7-7c12-11e6-8a84-bae500000068",
      "name": "Товар1",
      "code": "00002",
      "barcodes": [
        "2000000000022"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "uom": "шт",
      "egaisIsAlcoholic": true,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "stock": -1,
      "reserve": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
        "mediaType": "application/json",
        "type": "product",
        "id": "81fdf852-7c21-11e6-8a84-bae500000068",
        "idType": "native"
      },
      "id": "81fdf852-7c21-11e6-8a84-bae500000068",
      "name": "Пиво",
      "code": "00003",
      "barcodes": [
        "2000000000039"
      ],
      "salePrices": [
        {
          "value": 1000,
          "priceType": "Цена продажи"
        },
        {
          "value": 2000,
          "priceType": "Цена праздничная"
        }
      ],
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
          "idType": "native"
        },
        "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
        "name": "Овощи",
        "namepath": "Овощи",
        "path": "/dbe2cf7f-7b5c-11e6-8a84-bae50000000e/"
      },
      "article": "Ovosh1",
      "uom": "шт",
      "egaisIsAlcoholic": true,
      "egaisHasExciseMark": false,
      "egaisProductCode": 1,
      "egaisVolume": 2,
      "egaisAlcoholPercent": 0.3,
      "soldByWeight": false,
      "onTap": false,
      "stock": -208,
      "reserve": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/86e8625c-7b1d-11e6-8a84-bae500000106",
        "mediaType": "application/json",
        "type": "product",
        "id": "86e8625c-7b1d-11e6-8a84-bae500000106",
        "idType": "native"
      },
      "id": "86e8625c-7b1d-11e6-8a84-bae500000106",
      "name": "Товар",
      "code": "00001",
      "barcodes": [
        "2000000000015"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "uom": "шт",
      "egaisIsAlcoholic": true,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "stock": -23,
      "reserve": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/service/a22fb175-7fcf-11e6-8a84-bae500000005",
        "mediaType": "application/json",
        "type": "service",
        "id": "a22fb175-7fcf-11e6-8a84-bae500000005",
        "idType": "native"
      },
      "id": "a22fb175-7fcf-11e6-8a84-bae500000005",
      "name": "Услуга",
      "code": "00004",
      "barcodes": [
        "2000000000046"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "uom": "шт"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/b2334e83-7fcf-11e6-8a84-bae50000000c",
        "mediaType": "application/json",
        "type": "product",
        "id": "b2334e83-7fcf-11e6-8a84-bae50000000c",
        "idType": "native"
      },
      "id": "b2334e83-7fcf-11e6-8a84-bae50000000c",
      "name": "Товар2",
      "code": "00005",
      "barcodes": [
        "2000000000053"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "uom": "шт",
      "egaisIsAlcoholic": false,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "stock": 0,
      "reserve": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/variant/b23bf8f1-7fcf-11e6-8a84-bae500000010",
        "mediaType": "application/json",
        "type": "variant",
        "id": "b23bf8f1-7fcf-11e6-8a84-bae500000010",
        "idType": "native"
      },
      "id": "b23bf8f1-7fcf-11e6-8a84-bae500000010",
      "name": "(Mod)",
      "code": "00002",
      "barcodes": [
        "2000000000060"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "characteristics": {
        "Style": "Hip"
      },
      "product": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/b2334e83-7fcf-11e6-8a84-bae50000000c",
          "mediaType": "application/json",
          "type": "product",
          "id": "b2334e83-7fcf-11e6-8a84-bae50000000c",
          "idType": "native"
        },
        "id": "b2334e83-7fcf-11e6-8a84-bae50000000c",
        "name": "Товар2",
        "code": "00005",
        "uom": "шт",
        "egaisIsAlcoholic": false,
        "egaisHasExciseMark": false,
        "egaisVolume": 0,
        "egaisAlcoholPercent": 0,
        "soldByWeight": false,
        "onTap": false,
        "stock": 0,
        "reserve": 0
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/variant/b23ed636-7fcf-11e6-8a84-bae500000014",
        "mediaType": "application/json",
        "type": "variant",
        "id": "b23ed636-7fcf-11e6-8a84-bae500000014",
        "idType": "native"
      },
      "id": "b23ed636-7fcf-11e6-8a84-bae500000014",
      "name": "(Hop)",
      "code": "00003",
      "barcodes": [
        "2000000000077"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "characteristics": {
        "Style": "Hop"
      },
      "product": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/b2334e83-7fcf-11e6-8a84-bae50000000c",
          "mediaType": "application/json",
          "type": "product",
          "id": "b2334e83-7fcf-11e6-8a84-bae50000000c",
          "idType": "native"
        },
        "id": "b2334e83-7fcf-11e6-8a84-bae50000000c",
        "name": "Товар2",
        "code": "00005",
        "uom": "шт",
        "egaisIsAlcoholic": false,
        "egaisHasExciseMark": false,
        "egaisVolume": 0,
        "egaisAlcoholPercent": 0,
        "soldByWeight": false,
        "onTap": false,
        "stock": 0,
        "reserve": 0
      }
    },
    {
      "meta": {
        "href": "http://localhost/api/posap/1.0/entity/product/216e7496-6112-11e9-ac13-000c000000bc",
        "mediaType": "application/json",
        "type": "product",
        "id": "216e7496-6112-11e9-ac13-000c000000bc",
        "idType": "native"
      },
      "id": "216e7496-6112-11e9-ac13-000c000000bc",
      "name": "Товар",
      "code": "00001",
      "barcodes": [
        "2000000000015"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "favorite": false,
      "uom": "шт",
      "egaisIsAlcoholic": false,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "tobacco": false,
      "trackingType": "NOT_TRACKED",
      "stock": 0,
      "reserve": 0,
      "isSerialTrackable": false
    },
    {
      "meta": {
        "href": "http://localhost/api/posap/1.0/entity/product/ace86997-6113-11e9-ac13-000c000000c9",
        "mediaType": "application/json",
        "type": "product",
        "id": "ace86997-6113-11e9-ac13-000c000000c9",
        "idType": "native"
      },
      "id": "ace86997-6113-11e9-ac13-000c000000c9",
      "name": "shoes",
      "code": "00002",
      "barcodes": [
        "2000000000022"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "favorite": false,
      "uom": "шт",
      "egaisIsAlcoholic": false,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "tobacco": false,
      "trackingType": "SHOES",
      "stock": 0,
      "reserve": 0,
      "isSerialTrackable": false,
      "partialDisposal": false
    },
    {
      "meta": {
        "href": "http://localhost/api/posap/1.0/entity/product/c1d3dacb-6113-11e9-ac13-000c000000d2",
        "mediaType": "application/json",
        "type": "product",
        "id": "c1d3dacb-6113-11e9-ac13-000c000000d2",
        "idType": "native"
      },
      "id": "c1d3dacb-6113-11e9-ac13-000c000000d2",
      "name": "tobacco",
      "code": "00003",
      "barcodes": [
        "2000000000039"
      ],
      "salePrices": [
        {
          "value": 0,
          "priceType": "Цена продажи"
        }
      ],
      "favorite": false,
      "uom": "шт",
      "egaisIsAlcoholic": false,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "tobacco": true,
      "trackingType": "TOBACCO",
      "stock": 0,
      "reserve": 0,
      "isSerialTrackable": false,
      "partialDisposal": false
    }
  ]
}

Загрузка товаров
GET/entity/assortment

Создание продажи

Теперь, имея открытую смену и справочник товаров, создадим пробную розничную продажу.

POST https://online.moysklad.ru/api/posap/1.0/entity/retaildemand
Requestsсоздание продажи

Пример создания новой розничной продажи.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147753335ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: example@admin
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/388bd178-800c-11e6-8a84-bae5022000a2"
    }
  },
  "name": "000219991",
  "moment": "2016-09-06 21:41:46",
  "description": "размен",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "discountSum": 100,
      "vat": 10,
      "vatSum": 100,
      "sum": 1000,
      "pdf": [
        "abc",
        "def"
      ],
      "marks": [
        {
          "cis": "12345678900987ABCDEFGabcdefgh"
        },
        {
          "cis": "00000046185372KY4mjNZAB=U/FkO"
        }
      ]
    }
  ],
  "cashSum": 800,
  "noCashSum": 100,
  "vatEnabled": true,
  "vatIncluded": true,
  "bottleUrl": "https://check.egais.ru?id=a9e56cb9-21d6-4404-9f24-668020fadf6a&amp;dt=0910141104&amp;cn=Magazin2014",
  "bottleSign": "418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B",
  "chequeEmail": "test@test.org",
  "chequePhone": "123456",
  "electronicCheque": true,
  "paperCheque": true
}
Responses201
This response has no content.

Создание продажи
POST/entity/retaildemand

Закрытие смены

По окончании работы закроем открытую нами ранее розничную смену.

PUT https://online.moysklad.ru/api/posap/1.0/rpc/closeshift/
RequestsПример

Пример запроса на закрытие смены.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147753335ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: example@admin
BodyСкрытьПоказать
{
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/388bd178-800c-11e6-8a84-bae5022000a2"
    }
  },
  "closemoment": "2016-09-06 22:40:00"
}
Responses204
This response has no content.

Закрытие смены
PUT/rpc/closeshift/

В запрос передаём meta от ранее открытой смены, а также момент закрытия.

Точка продаж

Авторизация (BASIC)

Для данного ресурса предусмотрена обычная BASIC авторизация по паре логин-пароль.

Точка продаж

GET https://online.moysklad.ru/api/posap/1.0/admin/retailstore
Responses200

Успешный запрос. Результат - JSON представление точки продаж.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/admin/retailstore",
    "mediaType": "application/json",
    "size": 1,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailstore/5d4d2ca2-7b1d-11e6-8a84-bae500000060",
        "mediaType": "application/json",
        "type": "retailstore",
        "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
        "idType": "native"
      },
      "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
      "version": 2,
      "updated": "2016-09-21 19:27:45",
      "name": "Точка продаж",
      "externalCode": "W0M-XxXYjPZJjA1cT3RTL2",
      "controlShippingStock": true,
      "onlyInStock": false,
      "controlCashierChoice": false,
      "discountEnable": true,
      "discountMaxPercent": 100,
      "priceType": "Цена продажи",
      "authTokenAttached": true,
      "requiredFio": false,
      "requiredPhone": true,
      "requiredEmail": false,
      "requiredBirthdate": false,
      "requiredSex": false,
      "requiredDiscountCardNumber": false,
      "allowDeleteReceiptPositions": true,
      "syncAgents": true,
      "marksCheckMode": "CORRECT_MARKS_ONLY",
      "sendMarksToChestnyZnakOnCloud": false,
      "testChestnyZnakMode": true,
      "cashiers": {
        "rows": [
          {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/employee/a4f36276-7b5a-11e6-8a84-bae500000004",
              "mediaType": "application/json",
              "type": "employee",
              "id": "a4f36276-7b5a-11e6-8a84-bae500000004",
              "idType": "native"
            },
            "uid": "cashier@myorg",
            "firstName": "Иван",
            "middleName": "Иванович",
            "lastName": "Иванов",
            "image": {
              "href": "http://online.moysklad.ru/api/posap/1.0/download/35629a98-d029-11e7-0532-9eed00000001",
              "miniature": "http://online.moysklad.ru/api/posap/1.0/download/35629a98-d029-11e7-0532-9eed00000001?miniature=true",
              "tiny": "http://online.moysklad.ru/app/download/3626405c-d029-11e7-0532-9eed00000002/t.png"
            },
            "inn": "222490425273",
            "position": "position",
            "email": "ivanov@myorg.ru"
          }
        ]
      },
      "organization": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/organization/5d0f5e3e-7b1d-11e6-8a84-bae500000051",
          "mediaType": "application/json",
          "type": "organization",
          "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
          "idType": "native"
        },
        "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
        "version": 5,
        "updated": "2016-09-21 14:30:43",
        "name": "myorg",
        "description": "Страховое публичное акционерное общество «РЕСО-Гарантия»",
        "code": "1234",
        "externalCode": "PW55m0xUiG1pAlGJv73Sd2",
        "companyType": "legal",
        "legalTitle": "СТРАХОВОЕ ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"РЕСО-ГАРАНТИЯ\"",
        "legalAddress": "г Москва, ул Гашека, д 12 к 1",
        "actualAddress": "г Москва, ул Вавилова д 19",
        "inn": "7710045520",
        "kpp": "775001001",
        "ogrn": "1027700042413",
        "okpo": "121351253251",
        "email": "myorg@orgmy.su",
        "phone": "346243637247",
        "fax": "32472377432524",
        "isEgaisEnable": true,
        "fsrarId": "the id for fr",
        "payerVat": true,
        "utmUrl": "url.coms"
      },
      "store": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/store/5d1fa036-7b1d-11e6-8a84-bae500000053",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "5d1fa036-7b1d-11e6-8a84-bae500000053",
          "idType": "native"
        },
        "name": "Основной склад",
        "pathName": "",
        "address": "г Москва ул Милашенкова д 2"
      },
      "acquire": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
          "idType": "native"
        }
      },
      "lastOperationNames": [
        {
          "entity": "retaildemand",
          "name": "03211312",
          "moment": "2016-10-07 15:50:14"
        },
        {
          "entity": "retaildrawercashin",
          "name": "00001",
          "moment": "2016-10-07 15:50:14"
        },
        {
          "entity": "retaildrawercashout",
          "name": "00001",
          "moment": "2016-10-07 15:50:14"
        },
        {
          "entity": "retailsalesreturn",
          "name": "0002199921",
          "moment": "2016-10-07 15:50:14"
        },
        {
          "entity": "retailshift",
          "name": "042777001",
          "moment": "2016-10-07 15:50:14"
        }
      ],
      "egaisEnabled": false,
      "frNumber": "",
      "returnFromClosedShiftEnabled": false,
      "alwaysPrintCheck": false,
      "issueOrders": false,
      "sellReserves": false,
      "ofdEnabled": false,
      "allowCustomPrice": false,
      "cash": 10050,
      "createPaymentInOnRetailShiftClosing": true,
      "createCashInOnRetailShiftClosing": false,
      "allowCreateProducts": true,
      "enableReturnsWithNoReason": true,
      "isOnlineDiscount": false,
      "isExternalCustomers": false,
      "isPhonePriority": true,
      "reservePrepaidGoods": false,
      "receiptTemplate": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/receipttemplate/4636cc33-d372-11e8-ac16-000900000001",
          "mediaType": "application/json",
          "type": "receipttemplate",
          "id": "4636cc33-d372-11e8-ac16-000900000001",
          "idType": "native"
        },
        "header": "АКЦИЯ: 6 ЗА 5. ПОДРОБНЕЕ ЧИТАЙТЕ В НИЖНЕЙ ЧАСТИ ЧЕКА",
        "footer": "КУПИТЕ 5 КОФЕ И ПОЛУЧИТЕ 6-й В ПОДАРОК, ПРЕДЪЯВИВ ЭТОТ ЧЕК"
      },
      "environment": {
        "device": "RetailStorePc",
        "os": "Linux",
        "software": {
          "name": "Касса МойСклад",
          "vendor": "МойСклад",
          "version": "2.2"
        },
        "chequePrinter": {
          "vendor": "АТОЛ",
          "name": "30Ф",
          "serial": "15636313",
          "fiscalDataVersion": "1.0",
          "driver": {
            "name": "АТОЛ (бета)",
            "version": "9.1"
          },
          "fiscalMemory": {
            "fiscalDataVersion": "1.1"
          },
          "firmwareVersion": "669"
        },
        "paymentTerminal": {
          "acquiringType": "payme"
        }
      },
      "state": {
        "sync": {
          "message": "Ошибка синхронизации, необходимо войти повторно",
          "lastAttempMoment": "2016-09-06 21:41:00"
        },
        "lastCheckMoment": "2018-06-13 16:18:00",
        "fiscalMemory": {
          "error": {
            "code": "1003",
            "message": "Критическая ошибка"
          },
          "notSendDocCount": 25,
          "notSendFirstDocMoment": "2016-09-06 21:41:00"
        },
        "paymentTerminal": {
          "acquiringType": "payme"
        }
      },
      "qrPayEnabled": true,
      "qrAcquire": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
          "idType": "native"
        }
      },
      "enableNotMRCTobaccoSale": false,
      "tobaccoMrcControlType": "SAME_PRICE",
      "markingSellingMode": "CORRECT_MARKS_ONLY",
      "sendMarksForCheck": false
    }
  ]
}

Получить точки продаж
GET/admin/retailstore

Запрос на получение точек продаж, на которых пользователь является кассиром.

Атрибуты объектов ответа

  • meta - Метаданные точки продаж Необходимое

  • id - ID в формате UUID Необходимое

  • version - Версия сущности Необходимое

  • updated - Момент последнего обновления сущности Необходимое

  • name - Наименование точки продаж Необходимое

  • description - Описание точки продаж

  • externalCode - Внешний код точки продаж Необходимое

  • address - Адрес

  • controlShippingStock - Контроль остатков Необходимое

  • onlyInStock - Выгружать только товары в наличии. Доступно только при активном контроле остатков.

  • controlCashierChoice - Выбор продавца Необходимое

  • discountEnable - Разрешить ручные скидки Необходимое

  • discountMaxPercent - Максимально разрешенная скидка Необходимое

  • priceType - Тип цен, с которыми будут продаваться товары в рознице Необходимое

  • authTokenAttached - Флаг, указывающий, что для точки продаж уже был установлен токен обмена (повторная установка токена может привести к тому, что данные с предыдущего устройства перестанут выгружаться) Необходимое

  • cashiers - Кассиры которые могут работать на точке продаж Необходимое. Выводится максимум 100 кассиров.

    • meta - метаданные
    • uid - идентификатор учетной записи кассира
    • firstName - Имя
    • middleName - Отчество
    • lastName - Фамилия
    • pinCode - ПИН-код
    • image - Фотография кассира
      • href - Ссылка на изображение
      • miniature - Ссылка на миниатюру изображения
      • tiny - Ссылка на уменьшенную версию изображения
    • inn - ИНН
    • position - Должность
    • email - Адрес электронной почты

  • organization - организация которой принадлежит точка продаж Необходимое

    • meta - метаданные Необходимое
    • name - Краткое наименование Необходимое
    • companyType - Тип организации Необходимое
    • legalTitle- Полное наименование
    • legalAddress- Юридический адрес
    • actualAddress - Фактический адрес
    • inn - ИНН
    • kpp - КПП
    • ogrn - ОГРН
    • okpo - ОКПО
    • ogrnip - ОГРНИП
    • certificateNumber - Номер свидетельства
    • certificateDate - Дата свидетельства
    • email - Адрес электронной почты
    • phone - Номер телефона
    • fax - факс
    • isEgaisEnable - ЕГАИС включен
    • payerVat- Плательщик НДС
    • fsrarId - Идентификатор в ФСРАР
    • utmUrl - Адрес и порт УТМ

  • store - склад с которого торгует точка продаж

    • meta - Метаданные
    • name - Наименование склада
    • parent - родительский склад
    • pathName - Группа, к которой относится склад Необходимое
    • address - Адрес Необходимое

  • acquire - Банк эквайер операций по карте

    • meta - Метаданные

  • lastOperationNames - коллекция номеров последних созданных документов на данной точке продаж. Необходимое Каждый элемент коллекции - тип и имя

    • entity - тип документа Необходимое
    • name - Номер документа Необходимое
    • moment - Дата документа Необходимое

  • egaisEnabled - Точка продаж должна передавать данные в ЕГАИС Необходимое

  • frNumber - Номер модели ФР Необходимое

  • returnFromClosedShiftEnabled - Разрешить возвраты в закрытых сменах Необходимое

  • alwaysPrintCheck - Обязательная печать чеков Необходимое

  • issueOrders - Выдача заказов Необходимое

  • sellReserves - Учет резервов Необходимое

  • ofdEnabled - Отправлять электронный чек через ОФД Необходимое

  • allowCustomPrice - Разрешить продажу по свободной цене Необходимое

  • cash - Остаток денег в кассе Необходимое

  • createPaymentInOnRetailShiftClosing - Создавать входящий платеж при закрытии смен. Если флаг включен, в закрываемой смене указан банк-эквайер и безналичная выручка за смену (с учетом комиссии) больше 0, то при закрытии смены будет создан входящий платеж Необходимое

  • createCashInOnRetailShiftClosing - Создавать ПКО при закрытии смены. Если флаг включен, в операции закрытия смены есть ссылка на выплату и сумма выплаты больше 0, то при закрытии смены будет создан связанный ПКО Необходимое

  • allowCreateProducts - Разрешить создавать товары

  • allowCreateReturnWithoutDemand - Разрешить создание возвратов без основания

  • isPhonePriority - Приоритет отправки электронного чека на телефон. Если флаг выключен, приоритет отправки изменяется на email. Поле недоступно, если приоритет имеет значение Не отправлять или выключен флаг для отправки электронного чека через ОФД .

  • isOnlineDiscount - Возможность использовать скидку и рассчитывать чек на стороне сервера

  • receiptTemplate - Шаблон чека

    • meta - Метаданные шаблона чека
    • header - Верхний блок шаблона чека
    • footer - Нижний блок шаблона чека

  • reservePrepaidGoods - Резервировать товары за которые внесена предоплата

  • environment - информация об окружении

    • device - информация об устройстве
    • os - информация об операционной системе
    • software - информация о ПО
      • name - наименование ПО. Необходимое
      • vendor - Производитель.
      • version - версия ПО.
    • chequePrinter - данные о ККТ
      • vendor - Производитель
      • name - Наименование. Необходимое
      • serial - серийный номер
      • fiscalDataVersion - формат фискальных данных
      • driver - информация об используемом драйвере
        • name - наименования драйвера
        • version - Версия драйвера
      • fiscalMemory - информация о фискальном накопителе
        • fiscalDataVersion - версия фискальной памяти
      • firmwareVersion - Версия прошивки ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)

  • state - информация о статусе точки продаж

    • sync - состояние синхронизации
      • message - состояние синхронизации.
      • lastAttempMoment - Дата последней сихронизации (не обязательно успешной). Необходимое
    • lastCheckMoment - дата и время последней синхронизации
    • fiscalMemory - информация о фискальной памяти
      • error - информация об ошибке ФН
        • сode - код ошибки ФН
        • message - описание ошибки
      • notSendDocCount - Количество неотправленных документов в ОФД
      • notSendFirstDocMoment - Дата первого документа в очереди на отправку
    • paymentTerminal - информация о платежном терминале Deprecated
      • acquiringType - информация о типе эквайера (например: inpas/payme)

  • enableNotMRCTobaccoSale - Разрешить продавать табачную продукцию не по МРЦ. Deprecated

  • tobaccoMrcControlType - Контроль МРЦ для табачной продукции

  • markingSellingMode - Продажа маркированных товаров

  • qrPayEnabled - возможность оплаты по QR-коду на точке продаж

  • qrAcquire - банк эквайер операций по QR-коду

    • meta - Метаданные

  • isExternalCustomers - Возможность искать покупателей во внешней системе лояльности

  • sendMarksForCheck - настройки для указания необходимости передавать коды маркировки для проверки с ККТ в мастер-кассу

  • requiredFio - Обязательность поля ФИО при создании контрагента, по умолчанию false

  • requiredPhone - Обязательность поля телефон при создании контрагента, по умолчанию true

  • requiredEmail - Обязательность поля эл. почта при создании контрагента, по умолчанию false

  • requiredBirthdate - Обязательность поля дата рождения при создании контрагента, по умолчанию false

  • requiredSex - Обязательность поля пол при создании контрагента, по умолчанию false

  • requiredDiscountCardNumber - Обязательность поля номер дисконтной карты при создании контрагента, по умолчанию false

  • allowDeleteReceiptPositions - настройка разрешения удаления позиции в чеке

  • syncAgents - настройка выгружать покупателей для работы оффлайн, по умолчанию true

  • marksCheckMode - настройка проверки КМ перед продажей в ГИС МТ (по умолчанию CORRECT_MARKS_ONLY)

  • sendMarksToChestnyZnakOnCloud - настройка для облачных точек — отправлять коды маркировки на проверку в Честный Знак, по умолчанию false

  • testChestnyZnakMode - настройка включения тестового режима Честного знака для новых типов маркированных товаров, по умолчанию true

Привязка точки, получение токена

Авторизация (BASIC)

Для данного ресурса предусмотрена обычная BASIC авторизация по паре логин-пароль с небольшим отличием от стандартного поведения - сервер вместе с кодом 401 не возвращает заголовок WWW-Authenticate после неудачной аутентификации.

Получение Token

Данный ресурс предназначен для получения token для аутентификации на конкретной точке продаж. Id точки продаж передаётся в параметрах запроса. Данный запрос могут выполнить только кассиры на данной точке продаж и администраторы. Получить информацию о точках продаж можно воспользовавшись этим ресурсом.

  • Если пользователь не является кассиром или администратором - в результате запроса произойдёт ошибка с кодом 403.

  • Если точка продаж с указанным id не найдена - возникнет ошибка с кодом 404.

После успешного запроса происходит создание токена обмена для данной точки продаж, который будет заменять связку логин-пароль при обращении к ресурсам розницы. Все предыдущие токены для точки при этом аннулируются.

POST https://online.moysklad.ru/api/posap/1.0/admin/attach/7944ef04-f831-11e5-7a69-971500188b19
Responses201

Успешный запрос. Результат - токен для последующей аутентификации на данной точке продаж.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "token": "6ab89be1ae6ff147755625ee8da948e42612233b",
  "uid": "kassir@321"
}

Назначить токен для точки продаж
POST/admin/attach/{id}

URI Параметры
СкрытьПоказать
id
string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id точки продаж, которой назначается token

Настройки точки продаж

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Настройки точки продаж

GET https://online.moysklad.ru/api/posap/1.0/settings/retailstore/
Responses200

Успешный запрос. Результат - JSON представление точки продаж.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailstore/5d4d2ca2-7b1d-11e6-8a84-bae500000060",
    "mediaType": "application/json",
    "type": "retailstore",
    "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
    "idType": "native"
  },
  "id": "5d4d2ca2-7b1d-11e6-8a84-bae500000060",
  "version": 2,
  "updated": "2016-09-21 19:27:45",
  "name": "Точка продаж",
  "externalCode": "W0M-XxXYjPZJjA1cT3RTL2",
  "controlShippingStock": true,
  "onlyInStock": false,
  "controlCashierChoice": false,
  "discountEnable": true,
  "discountMaxPercent": 100,
  "priceType": "Цена продажи",
  "authTokenAttached": true,
  "requiredFio": false,
  "requiredPhone": true,
  "requiredEmail": false,
  "requiredBirthdate": false,
  "requiredSex": false,
  "requiredDiscountCardNumber": false,
  "allowDeleteReceiptPositions": true,
  "syncAgents": true,
  "marksCheckMode": "CORRECT_MARKS_ONLY",
  "sendMarksToChestnyZnakOnCloud": false,
  "testChestnyZnakMode": true,
  "cashiers": {
    "rows": [
      {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/employee/a4f36276-7b5a-11e6-8a84-bae500000004",
          "mediaType": "application/json",
          "type": "employee",
          "id": "a4f36276-7b5a-11e6-8a84-bae500000004",
          "idType": "native"
        },
        "uid": "cashier@myorg",
        "firstName": "Иван",
        "middleName": "Иванович",
        "lastName": "Иванов",
        "image": {
          "href": "http://online.moysklad.ru/api/posap/1.0/download/35629a98-d029-11e7-0532-9eed00000001",
          "miniature": "http://online.moysklad.ru/api/posap/1.0/download/35629a98-d029-11e7-0532-9eed00000001?miniature=true",
          "tiny": "http://online.moysklad.ru/app/download/3626405c-d029-11e7-0532-9eed00000002/t.png"
        },
        "inn": "222490425273",
        "position": "position",
        "email": "ivanov@myorg.ru"
      }
    ]
  },
  "organization": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/organization/5d0f5e3e-7b1d-11e6-8a84-bae500000051",
      "mediaType": "application/json",
      "type": "organization",
      "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
      "idType": "native"
    },
    "id": "5d0f5e3e-7b1d-11e6-8a84-bae500000051",
    "version": 5,
    "updated": "2016-09-21 14:30:43",
    "name": "myorg",
    "description": "Страховое публичное акционерное общество «РЕСО-Гарантия»",
    "code": "1234",
    "externalCode": "PW55m0xUiG1pAlGJv73Sd2",
    "companyType": "legal",
    "legalTitle": "СТРАХОВОЕ ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"РЕСО-ГАРАНТИЯ\"",
    "legalAddress": "г Москва, ул Гашека, д 12 к 1",
    "actualAddress": "г Москва, ул Вавилова д 19",
    "inn": "7710045520",
    "kpp": "775001001",
    "ogrn": "1027700042413",
    "okpo": "121351253251",
    "email": "myorg@orgmy.su",
    "phone": "346243637247",
    "fax": "32472377432524",
    "isEgaisEnable": true,
    "fsrarId": "the id for fr",
    "payerVat": true,
    "utmUrl": "url.coms"
  },
  "store": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/store/5d1fa036-7b1d-11e6-8a84-bae500000053",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "5d1fa036-7b1d-11e6-8a84-bae500000053",
      "idType": "native"
    },
    "name": "Основной склад",
    "pathName": "",
    "address": "г Москва ул Милашенкова д 2"
  },
  "acquire": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "idType": "native"
    }
  },
  "lastOperationNames": [
    {
      "entity": "retaildemand",
      "name": "03211312",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retaildrawercashin",
      "name": "00001",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retaildrawercashout",
      "name": "00001",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retailsalesreturn",
      "name": "0002199921",
      "moment": "2016-10-07 15:50:14"
    },
    {
      "entity": "retailshift",
      "name": "042777001",
      "moment": "2016-10-07 15:50:14"
    }
  ],
  "egaisEnabled": false,
  "frNumber": "",
  "returnFromClosedShiftEnabled": false,
  "alwaysPrintCheck": false,
  "issueOrders": false,
  "sellReserves": false,
  "ofdEnabled": false,
  "allowCustomPrice": false,
  "cash": 10050,
  "createPaymentInOnRetailShiftClosing": true,
  "createCashInOnRetailShiftClosing": false,
  "allowCreateProducts": true,
  "enableReturnsWithNoReason": true,
  "isOnlineDiscount": false,
  "isExternalCustomers": false,
  "isPhonePriority": true,
  "reservePrepaidGoods": false,
  "receiptTemplate": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/receipttemplate/4636cc33-d372-11e8-ac16-000900000001",
      "mediaType": "application/json",
      "type": "receipttemplate",
      "id": "4636cc33-d372-11e8-ac16-000900000001",
      "idType": "native"
    },
    "header": "АКЦИЯ: 6 ЗА 5. ПОДРОБНЕЕ ЧИТАЙТЕ В НИЖНЕЙ ЧАСТИ ЧЕКА",
    "footer": "КУПИТЕ 5 КОФЕ И ПОЛУЧИТЕ 6-й В ПОДАРОК, ПРЕДЪЯВИВ ЭТОТ ЧЕК"
  },
  "environment": {
    "device": "RetailStorePc",
    "os": "Linux",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.1"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    }
  },
  "state": {
    "sync": {
      "message": "Ошибка синхронизации, необходимо войти повторно",
      "lastAttempMoment": "2016-09-06 21:41:00"
    },
    "lastCheckMoment": "2018-06-13 16:18:00",
    "fiscalMemory": {
      "error": {
        "code": "1003",
        "message": "Критическая ошибка"
      },
      "notSendDocCount": 25,
      "notSendFirstDocMoment": "2016-09-06 21:41:00"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    }
  },
  "qrPayEnabled": true,
  "qrAcquire": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "idType": "native"
    }
  },
  "enableNotMRCTobaccoSale": false,
  "tobaccoMrcControlType": "SAME_PRICE",
  "markingSellingMode": "CORRECT_MARKS_ONLY",
  "sendMarksForCheck": false
}

Получить настройки точки продаж
GET/settings/retailstore/

Запрос на получение отдельной точки продаж (настроек точки продаж).

Атрибуты ответа

  • meta - Метаданные о смене Необходимое

  • id - ID в формате UUID Необходимое

  • version - Версия сущности Необходимое

  • updated - Момент последнего обновления сущности Необходимое

  • name - Наименование точки продаж Необходимое

  • description - Описание точки продаж Необходимое

  • externalCode - Внешний код точки продаж Необходимое

  • address - Адрес

  • controlShippingStock - Контроль остатков Необходимое

  • onlyInStock - Выгружать только товары в наличии. Доступно только при активном контроле остатков.

  • controlCashierChoice - Выбор продавца Необходимое

  • discountEnable - Разрешить ручные скидки Необходимое

  • discountMaxPercent - Максимально разрешенная скидка Необходимое

  • priceType - Тип цен, с которыми будут продаваться товары в рознице Необходимое

  • authTokenAttached - Флаг, указывающий, что для точки продаж уже был установлен токен обмена (повторная установка токена может привести к тому, что данные с предыдущего устройства перестанут выгружаться) Необходимое

  • cashiers - Кассиры которые могут работать на точке продаж Необходимое

    • meta - метаданные
    • uid - идентификатор учетной записи кассира
    • firstName - Имя
    • middleName - Отчество
    • lastName - Фамилия
    • pinCode - ПИН-код
    • image - Фотография кассира
      • href - Ссылка на изображение
      • miniature - Ссылка на миниатюру изображения
      • tiny - Ссылка на уменьшенную версию изображения
    • inn - ИНН
    • position - Должность
    • email - Адрес электронной почты

  • organization - организация которой принадлежит точка продаж Необходимое

    • meta - метаданные Необходимое
    • name - Краткое наименование Необходимое
    • companyType - Тип организации Необходимое
    • legalTitle- Полное наименование
    • legalAddress- Юридический адрес
    • actualAddress - Фактический адрес
    • inn - ИНН
    • kpp - КПП
    • ogrn - ОГРН
    • okpo - ОКПО
    • ogrnip - ОГРНИП
    • certificateNumber - Номер свидетельства
    • certificateDate - Дата свидетельства
    • email - Адрес электронной почты
    • phone - Номер телефона
    • fax - факс
    • isEgaisEnable - ЕГАИС включен
    • payerVat- Плательщик НДС
    • fsrarId - Идентификатор в ФСРАР
    • utmUrl - Адрес и порт УТМ

  • store - склад с которого торгует точка продаж

    • meta - Метаданные
    • name - Наименование склада
    • parent - родительский склад
    • pathName - Группа, к которой относится склад Необходимое
    • address - Адрес Необходимое

  • acquire - Банк эквайер операций по карте

    • meta - Метаданные

  • lastOperationNames - коллекция номеров последних созданных документов на данной точке продаж. Необходимое Каждый элемент коллекции - тип и имя

    • entity - тип документа Необходимое
    • name - Номер документа Необходимое
    • moment - Дата документа Необходимое

  • egaisEnabled - Точка продаж должна передавать данные в ЕГАИС Необходимое

  • frNumber - Номер модели ФР Необходимое

  • returnFromClosedShiftEnabled - Разрешить возвраты в закрытых сменах Необходимое

  • alwaysPrintCheck - Обязательная печать чеков Необходимое

  • issueOrders - Выдача заказов Необходимое

  • sellReserves - Учет резервов Необходимое

  • ofdEnabled - Отправлять электронный чек через ОФД Необходимое

  • allowCustomPrice - Разрешить продажу по свободной цене Необходимое

  • cash - Остаток денег в кассе Необходимое

  • createPaymentInOnRetailShiftClosing - Создавать входящий платеж при закрытии смен. Если флаг включен, в закрываемой смене указан банк-эквайер и безналичная выручка за смену (с учетом комиссии) больше 0, то при закрытии смены будет создан входящий платеж Необходимое

  • createCashInOnRetailShiftClosing - Создавать ПКО при закрытии смены. Если флаг включен, в операции закрытия смены есть ссылка на выплату и сумма выплаты больше 0, то при закрытии смены будет создан связанный ПКО Необходимое

  • allowCreateProducts - Разрешить создавать товары

  • allowCreateReturnWithoutDemand - Разрешить создание возвратов без основания

  • isPhonePriority - Приоритет отправки электронного чека на телефон. Если флаг выключен, приоритет отправки изменяется на email. Поле недоступно, если приоритет имеет значение Не отправлять или выключен флаг для отправки электронного чека через ОФД .

  • isOnlineDiscount - Возможность использовать скидку и рассчитывать чек на стороне сервера

  • receiptTemplate - Шаблон чека

    • meta - Метаданные шаблона чека
    • header - Верхний блок шаблона чека
    • footer - Нижний блок шаблона чека

  • environment - информация об окружении

    • device - информация об устройстве
    • os - информация об операционной системе
    • software - информация о ПО
      • name - наименование ПО. Необходимое
      • vendor - Производитель.
      • version - версия ПО.
    • chequePrinter - данные о ККТ
      • vendor - Производитель
      • name - Наименование. Необходимое
      • serial - серийный номер
      • fiscalDataVersion - формат фискальных данных
      • driver - информация об используемом драйвере
        • name - наименования драйвера
        • version - Версия драйвера
      • fiscalMemory - информация о фискальном накопителе
        • fiscalDataVersion - версия фискальной памяти
      • firmwareVersion - Версия прошивки ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)

  • state - информация о статусе точки продаж

    • sync - состояние синхронизации
      • message - состояние синхронизации.
      • lastAttempMoment - Дата последней сихронизации (не обязательно успешной). Необходимое
    • lastCheckMoment - дата и время последней синхронизации
    • fiscalMemory - информация о фискальной памяти
      • error - информация об ошибке ФН
        • сode - код ошибки ФН
        • message - описание ошибки
      • notSendDocCount - Количество неотправленных документов в ОФД
      • notSendFirstDocMoment - Дата первого документа в очереди на отправку
    • paymentTerminal - информация о платежном терминале Deprecated
      • acquiringType - информация о типе эквайера (например: inpas/payme)

  • defaultTaxSystem - Код системы налогообложения по умолчанию.

  • orderTaxSystem - Код системы налогообложения для заказов.

  • qrPayEnabled - возможность оплаты по QR-коду на точке продаж

  • qrAcquire - банк эквайер операций по QR-коду

  • requiredFio - Обязательность поля ФИО при создании контрагента

  • requiredPhone - Обязательность поля телефон при создании контрагента

  • requiredEmail - Обязательность поля эл. почта при создании контрагента

  • requiredBirthdate - Обязательность поля дата рождения при создании контрагента

  • requiredSex - Обязательность поля пол при создании контрагента

  • requiredDiscountCardNumber - Обязательность поля номер дисконтной карты при создании контрагента

    • meta - Метаданные

  • allowDeleteReceiptPositions - настройка разрешения удаления позиции в чеке

  • syncAgents - настройка выгружать покупателей для работы оффлайн

  • sendMarksToChestnyZnakOnCloud - настройка для облачных точек — отправлять коды маркировки на проверку в Честный Знак

  • testChestnyZnakMode - настройка включения тестового режима Честного знака для новых типов маркированных товаров

Система налогообложения Значение поля defaultTaxSystem/orderTaxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

  • enableNotMRCTobaccoSale - Разрешить продавать табачную продукцию не по МРЦ. Deprecated

  • tobaccoMrcControlType - Контроль МРЦ для табачной продукции. Необходимое

Контроль МРЦ для табачной продукции Значение поля tobaccoMrcControlType
Не контролировать МРЦ USER_PRICE
Продавать по МРЦ указанной на пачке MRC_PRICE
Запрещать продажу, если цена продажи не совпадает с МРЦ SAME_PRICE
  • fiscalType - Тип формирования чеков.
Формирование чеков Значение поля fiscalType
Стандартное STANDARD
Обработка облачных операций MASTER
Облачное CLOUD
  • markingSellingMode - Режим продажи маркированной продукции, если используется формат фискальных документов версии 1.2. Необходимое
Продажа маркированных товаров Значение поля markingSellingMode
Только проверенные и правильные коды маркировки CORRECT_MARKS_ONLY
Правильные коды и те, которые не удалось проверить WITHOUT_ERRORS
Все — независимо от результатов проверки кодов ALL
  • marksCheckMode - настройка проверки КМ перед продажей в ГИС МТ (по умолчанию CORRECT_MARKS_ONLY)
Продажа маркированных товаров Значение поля marksCheckMode
Только проверенные и правильные коды маркировки CORRECT_MARKS_ONLY
Правильные коды и те, которые не удалось проверить WITHOUT_ERRORS
Все — независимо от результатов проверки кодов ALL

  • isExternalCustomers - Возможность искать покупателей во внешней системе лояльности

  • sendMarksForCheck - настройки для указания необходимости передавать коды маркировки для проверки с ККТ в мастер-кассу

Настройки компании

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Настройки компании

GET https://online.moysklad.ru/api/posap/1.0/settings/companysettings
Responses200

Успешный запрос. Результат - JSON представление Настроек компании.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "currency": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/currency/5d204097-7b1d-11e6-8a84-bae500000058",
      "mediaType": "application/json",
      "type": "currency",
      "id": "5d204097-7b1d-11e6-8a84-bae500000058",
      "idType": "native"
    },
    "name": "руб",
    "rate": 1,
    "code": "643"
  },
  "discountStrategy": "bySum",
  "isWeightBarcodes": false,
  "weightBarcodePrefix": "00",
  "operationNumbering": "GLOBAL"
}

Получить Настройки компании
GET/settings/companysettings

Запрос на получение Настроек компании.

Атрибуты ответа:

  • currency - стандартная валюта Необходимое

    • meta - метаданные валюты Необходимое
    • name - наименование валюты Необходимое
    • rate - курс валюты Необходимое
    • code - код валюты Необходимое

  • discountStrategy - Cовместное применение скидок. Может принимать значения [bySum, byPriority] означающие “Сумма скидок” и “Приоритетная” соответственно. Необходимое

    • “Сумма скидок” [bySum] означает, что должна действовать сумма скидок
    • “Приоритетная” [byPriority] должна действовать одна, наиболее выгодная для покупателя скидка

  • isWeightBarcodes - Флаг, используются весовые штрихкоды Необходимое

  • weightBarcodePrefix - Строка, маска весовых штрихкодов Необходимое

  • operationNumbering - Нумерация документов. Может принимать значения [GLOBAL, YEARLY] означающие “Сквозная за всю историю” и “Внутри календарного года” соответственно. Необходимое

Скидки

Перед работой со скидками настоятельно рекомендуем вам прочитать вот эту статью на портале поддержки МоегоСклада.

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Скидки

GET https://online.moysklad.ru/api/posap/1.0/entity/discount
Responses200

Успешный запрос. Результат - список всех скидок всех типов на учетной записи.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/discount",
    "mediaType": "application/json",
    "size": 6,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/specialpricediscount/33edffd5-7ff9-11e6-8a84-bae500000057",
        "mediaType": "application/json",
        "type": "specialpricediscount",
        "id": "33edffd5-7ff9-11e6-8a84-bae500000057",
        "idType": "native"
      },
      "id": "33edffd5-7ff9-11e6-8a84-bae500000057",
      "name": "Скидка1",
      "allProducts": false,
      "productFolders": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
            "mediaType": "application/json",
            "type": "productfolder",
            "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
            "idType": "native"
          },
          "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
          "name": "Папка 1",
          "namepath": "",
          "path": "/"
        }
      ],
      "specialPrice": {
        "priceType": "Цена продажи"
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/specialpricediscount/38a43ee7-7ffd-11e6-8a84-bae50000005f",
        "mediaType": "application/json",
        "type": "specialpricediscount",
        "id": "38a43ee7-7ffd-11e6-8a84-bae50000005f",
        "idType": "native"
      },
      "id": "38a43ee7-7ffd-11e6-8a84-bae50000005f",
      "name": "Скидка2",
      "allProducts": false,
      "productFolders": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/276a6f50-7ffd-11e6-8a84-bae50000005c",
            "mediaType": "application/json",
            "type": "productfolder",
            "id": "276a6f50-7ffd-11e6-8a84-bae50000005c",
            "idType": "native"
          },
          "productFolder": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
              "mediaType": "application/json",
              "type": "productfolder",
              "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
              "idType": "native"
            }
          },
          "id": "276a6f50-7ffd-11e6-8a84-bae50000005c",
          "name": "Папка 2",
          "namepath": "Папка 1",
          "path": "/dbe2cf7f-7b5c-11e6-8a84-bae50000000e/"
        }
      ],
      "specialPrice": {
        "priceType": "Цена продажи"
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/941e8ce7-7b1d-11e6-8a84-bae500000111",
        "mediaType": "application/json",
        "type": "accumulationdiscount",
        "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
        "idType": "native"
      },
      "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
      "name": "Скидка 3",
      "allProducts": false,
      "levels": [
        {
          "amount": 10000,
          "discount": 1
        },
        {
          "amount": 20000,
          "discount": 2
        },
        {
          "amount": 30000,
          "discount": 3
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/98af408c-7fdc-11e6-8a84-bae50000003c",
        "mediaType": "application/json",
        "type": "accumulationdiscount",
        "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
        "idType": "native"
      },
      "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
      "name": "накопительная Скидка",
      "allProducts": false,
      "levels": [
        {
          "amount": 200000,
          "discount": 1
        },
        {
          "amount": 1200000,
          "discount": 2
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/fbd3a1b7-7fdd-11e6-8a84-bae500000047",
        "mediaType": "application/json",
        "type": "accumulationdiscount",
        "id": "fbd3a1b7-7fdd-11e6-8a84-bae500000047",
        "idType": "native"
      },
      "id": "fbd3a1b7-7fdd-11e6-8a84-bae500000047",
      "name": "Скидка 4",
      "allProducts": false,
      "levels": [
        {
          "amount": 20000,
          "discount": 0
        }
      ]
    }
  ]
}

Получить все скидки
GET/entity/discount

Запрос на получение всех скидок учётной записи.

Атрибуты ответа

Общие поля

  • meta - Метаданные Необходимое

  • id - ID в формате UUID Необходимое

  • name - Наименование скидки Необходимое

  • agentTags - Тэги контрагентов, к которым применяется скидка, если применяется не ко всем контрагентам

  • allProducts - Все товары и услуги. Если этот флаг выставлен true, то коллекции assortment и productFolders будут отсутствовать в составе объекта. Необходимое

  • assortment - Товары и услуги, которые были выбраны для применения скидки, если та применяется не ко всем товарам

Поля Спец. цен

  • productFolders - Товары и папки, к которым применяется скидка, если применяется не ко всем товарам

    • meta - метаданные папки
    • productFolder - ссылка на родительскую папку
    • id - id папки
    • name - наименование папки
    • namepath - путь к данной папке, состоящий из имён родительских папок
    • path - путь к данной папке, состоящий из id родительских папок

  • discount - Процент скидки если выбран фиксированный процент

  • specialPrice - Спец. цена (если выбран тип цен)

    • priceType - Наименование типа цены

Поля накопительных скидок

  • productFolders - Товары и папки, к которым применяется скидка, если применяется не ко всем товарам

    • meta - метаданные папки
    • productFolder - ссылка на родительскую папку
    • id - id папки
    • name - наименование папки
    • namepath - путь к данной папке, состоящий из имён родительских папок
    • path - путь к данной папке, состоящий из id родительских папок

  • levels - проценты скидок при определённой сумме продаж Необходимое

    • amount - Сумма накоплений в рублях
    • discount - Процент скидки, соответствующий данной сумме

Товары и услуги

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Товары и услуги

GET https://online.moysklad.ru/api/posap/1.0/entity/assortment
Responses200

Успешный запрос. Результат - JSON представление ассортимента товаров.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/assortment",
    "mediaType": "application/json",
    "size": 5,
    "limit": 4,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward",
    "nextHref": "http://online.moysklad.ru/api/posap/1.0/entity/assortment?limit=4&offsetId=ac6bab2d-07c8-11e7-8a84-bc5200000016&direction=forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/7db30ee8-07c5-11e7-90a5-ba9c0000008b",
        "mediaType": "application/json",
        "type": "product",
        "id": "7db30ee8-07c5-11e7-90a5-ba9c0000008b",
        "idType": "native"
      },
      "id": "7db30ee8-07c5-11e7-90a5-ba9c0000008b",
      "name": "товар алкогольный",
      "code": "00004",
      "barcodes": [
        "2000000000015"
      ],
      "salePrices": [
        {
          "value": 6000,
          "priceType": "Цена продажи"
        },
        {
          "value": 0,
          "priceType": "нулевая цена"
        }
      ],
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/200a6488-07c7-11e7-90a5-ba9c0000009a",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
          "idType": "native"
        },
        "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
        "name": "папка",
        "namepath": "папка",
        "path": "/200a6488-07c7-11e7-90a5-ba9c0000009a/"
      },
      "article": "артикул",
      "uom": "шт",
      "vat": 10,
      "useParentVat": false,
      "vatEnabled": true,
      "vatDecimal": 10,
      "image": {
        "href": "https://online.moysklad.ru/api/posap/1.0/download/64aab630-07c7-11e7-90a5-ba9c0000002c",
        "miniature": "https://online.moysklad.ru/api/posap/1.0/download/64aab630-07c7-11e7-90a5-ba9c0000002c?miniature=true",
        "tiny": "https://online.moysklad.ru/static/75651645-07c5-11e7-90a5-ba9c00000006/TinyImage/64aaa5a2-07c7-11e7-90a5-ba9c0000002b.png"
      },
      "egaisIsAlcoholic": true,
      "egaisHasExciseMark": false,
      "egaisProductCode": 444,
      "egaisVolume": 0.5,
      "egaisAlcoholPercent": 4,
      "soldByWeight": false,
      "onTap": false,
      "stock": 0,
      "reserve": 0,
      "isSerialtrackable": false,
      "tobacco": false,
      "paymentItemType": "EXCISABLE_GOOD",
      "isDiscountProhibited": false,
      "packs": [
        {
          "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
          "name": "ящ",
          "quantity": 10,
          "barcode": "2000000000016"
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/service/bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
        "mediaType": "application/json",
        "type": "service",
        "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
        "idType": "native"
      },
      "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
      "name": "Услуга",
      "code": "00006",
      "barcodes": [
        "2000000000060"
      ],
      "salePrices": [
        {
          "value": 1500,
          "priceType": "Цена продажи"
        },
        {
          "value": 0,
          "priceType": "нулевая цена"
        }
      ],
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/200a6488-07c7-11e7-90a5-ba9c0000009a",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
          "idType": "native"
        },
        "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
        "name": "папка",
        "namepath": "папка",
        "path": "/200a6488-07c7-11e7-90a5-ba9c0000009a/"
      },
      "uom": "шт",
      "vat": 10,
      "useParentVat": false,
      "vatEnabled": true,
      "vatDecimal": 10,
      "taxSystem": "GENERAL_TAX_SYSTEM",
      "paymentItemType": "SERVICE",
      "isDiscountProhibited": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/cd39d288-07c6-11e7-90a5-ba9c00000019",
        "mediaType": "application/json",
        "type": "product",
        "id": "cd39d288-07c6-11e7-90a5-ba9c00000019",
        "idType": "native"
      },
      "id": "cd39d288-07c6-11e7-90a5-ba9c00000019",
      "name": "Товар",
      "code": "00005",
      "barcodes": [
        "2000000000022",
        "2000000000053"
      ],
      "salePrices": [
        {
          "value": 1300,
          "priceType": "Цена продажи"
        },
        {
          "value": 0,
          "priceType": "нулевая цена"
        }
      ],
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/200a6488-07c7-11e7-90a5-ba9c0000009a",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
          "idType": "native"
        },
        "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
        "name": "папка",
        "namepath": "папка",
        "path": "/200a6488-07c7-11e7-90a5-ba9c0000009a/"
      },
      "article": "артикул",
      "uom": "шт",
      "vat": 10,
      "useParentVat": false,
      "vatEnabled": true,
      "vatDecimal": 10,
      "taxSystem": "SIMPLIFIED_TAX_SYSTEM_INCOME",
      "image": {
        "href": "https://online.moysklad.ru/api/posap/1.0/download/59af318d-07c7-11e7-90a5-ba9c00000028",
        "miniature": "https://online.moysklad.ru/api/posap/1.0/download/59af318d-07c7-11e7-90a5-ba9c00000028?miniature=true",
        "tiny": "https://online.moysklad.ru/static/75651645-07c5-11e7-90a5-ba9c00000006/TinyImage/59af0104-07c7-11e7-90a5-ba9c00000027.png"
      },
      "egaisIsAlcoholic": false,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": true,
      "onTap": false,
      "stock": 0,
      "reserve": 0,
      "isSerialtrackable": false,
      "tobacco": false,
      "paymentItemType": "GOOD",
      "isDiscountProhibited": true
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/variant/cd3ed8ed-07c6-11e7-90a5-ba9c00000020",
        "mediaType": "application/json",
        "type": "variant",
        "id": "cd3ed8ed-07c6-11e7-90a5-ba9c00000020",
        "idType": "native"
      },
      "id": "cd3ed8ed-07c6-11e7-90a5-ba9c00000020",
      "name": "Товар (версия1)",
      "code": "00002",
      "barcodes": [
        "2000000000039"
      ],
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/200a6488-07c7-11e7-90a5-ba9c0000009a",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
          "idType": "native"
        },
        "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
        "name": "папка",
        "namepath": "папка",
        "path": "/200a6488-07c7-11e7-90a5-ba9c0000009a/"
      },
      "characteristics": {
        "модификация": "версия1"
      },
      "stock": 0,
      "reserve": 0,
      "salePrices": [
        {
          "value": 1300,
          "priceType": "Цена продажи"
        },
        {
          "value": 0,
          "priceType": "нулевая цена"
        }
      ],
      "product": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/cd39d288-07c6-11e7-90a5-ba9c00000019",
          "mediaType": "application/json",
          "type": "product",
          "id": "cd39d288-07c6-11e7-90a5-ba9c00000019",
          "idType": "native"
        },
        "id": "cd39d288-07c6-11e7-90a5-ba9c00000019",
        "name": "Товар",
        "code": "00005",
        "salePrices": [
          {
            "value": 1300,
            "priceType": "Цена продажи"
          },
          {
            "value": 0,
            "priceType": "нулевая цена"
          }
        ],
        "article": "артикул",
        "uom": "шт",
        "vat": 10,
        "useParentVat": false,
        "vatEnabled": true,
        "vatDecimal": 10,
        "image": {
          "href": "https://online.moysklad.ru/api/posap/1.0/download/59af318d-07c7-11e7-90a5-ba9c00000028",
          "miniature": "https://online.moysklad.ru/api/posap/1.0/download/59af318d-07c7-11e7-90a5-ba9c00000028?miniature=true",
          "tiny": "https://online.moysklad.ru/static/75651645-07c5-11e7-90a5-ba9c00000006/TinyImage/59af0104-07c7-11e7-90a5-ba9c00000027.png"
        },
        "egaisIsAlcoholic": false,
        "egaisHasExciseMark": false,
        "egaisVolume": 0,
        "egaisAlcoholPercent": 0,
        "soldByWeight": true,
        "onTap": false,
        "stock": 0,
        "reserve": 0,
        "paymentItemType": "ANOTHER_PAYMENT_ITEM",
        "isDiscountProhibited": true
      },
      "isSerialtrackable": false
    },
    {
      "meta": {
        "href": "http://online.moysklad.ru/api/posap/1.0/entity/bundle/e90685f8-07c8-11e7-8a84-bc520000002d",
        "mediaType": "application/json",
        "type": "bundle",
        "id": "e90685f8-07c8-11e7-8a84-bc520000002d",
        "idType": "native"
      },
      "id": "e90685f8-07c8-11e7-8a84-bc520000002d",
      "name": "Комплект",
      "code": "00006",
      "barcodes": [
        "2000000000107"
      ],
      "salePrices": [
        {
          "value": 1500,
          "priceType": "Цена продажи"
        },
        {
          "value": 1900,
          "priceType": "нулевая цена"
        }
      ],
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/200a6488-07c7-11e7-90a5-ba9c0000009a",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
          "idType": "native"
        },
        "id": "200a6488-07c7-11e7-90a5-ba9c0000009a",
        "name": "папка",
        "namepath": "папка",
        "path": "/200a6488-07c7-11e7-90a5-ba9c0000009a/"
      },
      "article": "артикул",
      "uom": "шт",
      "vat": 18,
      "useParentVat": false,
      "vatEnabled": true,
      "vatDecimal": 18,
      "taxSystem": "PRESUMPTIVE_TAX_SYSTEM",
      "paymentItemType": "COMPOUND_PAYMENT_ITEM",
      "isDiscountProhibited": false,
      "image": {
        "href": "http://online.moysklad.ru/api/posap/1.0/download/d3c41c47-07c8-11e7-8a84-bc520000001f",
        "miniature": "http://online.moysklad.ru/api/posap/1.0/download/d3c41c47-07c8-11e7-8a84-bc520000001f?miniature=true",
        "tiny": "http://online.moysklad.ru/app/download/d3c3e54c-07c8-11e7-8a84-bc520000001e.png"
      },
      "components": [
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/cd39d288-07c6-11e7-90a5-ba9c00000019",
            "mediaType": "application/json",
            "type": "product",
            "id": "cd39d288-07c6-11e7-90a5-ba9c00000019",
            "idType": "native"
          },
          "quantity": 5
        },
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/variant/cd3ed8ed-07c6-11e7-90a5-ba9c00000020",
            "mediaType": "application/json",
            "type": "variant",
            "id": "ac6bab2d-07c8-11e7-8a84-bc5200000016",
            "idType": "native"
          },
          "quantity": 10
        },
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/service/bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
            "mediaType": "application/json",
            "type": "service",
            "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
            "idType": "native"
          },
          "quantity": 15
        }
      ]
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/cd39d288-07c6-11e7-90a5-ba9c00000020",
        "mediaType": "application/json",
        "type": "product",
        "id": "cd39d288-07c6-11e7-90a5-ba9c00000020",
        "idType": "native"
      },
      "id": "cd39d288-07c6-11e7-90a5-ba9c00000020",
      "name": "Маска",
      "code": "00077",
      "salePrices": [
        {
          "value": 3500,
          "priceType": "Цена продажи"
        }
      ],
      "article": "артикул",
      "uom": "шт",
      "vat": 20,
      "useParentVat": false,
      "vatEnabled": true,
      "vatDecimal": 20,
      "egaisIsAlcoholic": false,
      "egaisHasExciseMark": false,
      "egaisVolume": 0,
      "egaisAlcoholPercent": 0,
      "soldByWeight": false,
      "onTap": false,
      "stock": 0,
      "reserve": 0,
      "paymentItemType": "GOOD",
      "isDiscountProhibited": false,
      "ppeType": "2400001323807"
    }
  ]
}

Получить Товары и услуги
GET/entity/assortment

Запрос на получение товаров/модификаций и остатков по ним. Результат - список соответствующих сущностей с информацией по их остаткам на складе. Если в настройках точки продаж установлено свойство Выгружать только товары в наличии, то запрос вернет только товары и модификации с положительным остатком. Комплекты выгружаются все, вне зависимости от их остатка и значения свойства Выгружать только товары в наличии.

Атрибуты ответа:

Общие для товаров, модификаций, услуг и комплектов

  • meta - Метаданные сущности Необходимое

  • id - id сущности ассортимента Необходимое

  • syncId - syncId товара/услуги/комплекта, уникальный внешний идентификатор

  • name - Наименование сущности Необходимое

  • code - Код сущности

  • barcodes - Массив штрихкодов сущности

  • salePrices - Массив цен продажи (объектов с полем value) сущности Необходимое

  • productFolder - Папка, в которой находится сущность. Для модификаций папка родительского товара.

    • meta - метаданные папки Необходимое
    • productFolder - ссылка на родительскую папку
    • id - id папки Необходимое
    • name - наименование папки Необходимое
    • namepath - путь к товару, модификации, услуги или комплекту (но не к самой папке), состоящий из имён родительских папок Необходимое
    • path - путь к товару, модификации, услуги или комплекту (но не к самой папке), состоящий из id родительских папок Необходимое

  • vat - НДС, рассчитанный с учетом родительских групп, если такие имеются

  • vatEnabled - включен ли НДС для товара. С помощью этого флага для товара можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • useParentVat - использовать НДС родительской группы

  • vatDecimal - НДС дробный, рассчитанный с учетом родительских групп, если такие имеются

Поля товаров

  • article - Артикул товара

  • soldByWeight - Весовой товар

  • onTap - Разливной товар

  • uom - Единица измерения товара (строка)

  • image - Изображение товара (объект)

    • href - Ссылка на изображение
    • miniature - Ссылка на миниатюру изображения
    • tiny - Ссылка на уменьшенную версию изображения

  • egaisIsAlcoholic - признак «Алкогольная продукция» Необходимое

  • egaisHasExciseMark - признак «Содержит акцизную марку» Необходимое

  • egaisProductCode - код вида алкогольной продукции Необходимое

  • egaisAlcoholPercent - крепость алкогольной продукции Необходимое

  • egaisVolume - объем тары алкогольной продукции Необходимое

  • stock - Остаток Необходимое

  • reserve - Резерв Необходимое

  • isSerialtrackable - учёт по серийным номерам Необходимое

  • tobacco - Табачная продукция. Не может быть указан вместе с egaisIsAlcoholic, soldByWeight, isSerialtrackable и onTap

  • trackingType - Тип маркируемой продукции

    • NOT_TRACKED - Без маркировки
    • TOBACCO - Тип маркировки “Табак”
    • SHOES - Тип маркировки “Обувь”
    • LP_CLOTHES - Тип маркировки “Одежда”
    • LP_LINENS - Тип маркировки “Постельное белье”
    • PERFUMERY - Тип маркировки “Духи и туалетная вода”
    • ELECTRONICS - Тип маркировки “Фотокамеры и лампы-вспышки”
    • TIRES - Тип маркировки “Шины и покрышки”
    • MILK - Тип маркировки “Молочная продукция”
    • WATER - Тип маркировки “Упакованная вода”
    • OTP - Тип маркировки “Альтернативная табачная продукция”
    • NCP - Тип маркировки “Никотиносодержащая продукция”
    • BEER_ALCOHOL - Тип маркировки “Пиво и слабоалкогольная продукция”
    • FOOD_SUPPLEMENT - Тип маркировки “Биологически активные добавки к пище”
    • SANITIZER - Тип маркировки “Антисептики”

  • tnved - Код ТН ВЭД

  • taxSystem - Код системы налогообложения.

  • partialDisposal - Флаг частичного выбытия.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

  • paymentItemType - Признак предмета расчета

    • GOOD - Товар
    • EXCISABLE_GOOD - Подакцизный товар
    • COMPOUND_PAYMENT_ITEM - Составной предмет расчета
    • ANOTHER_PAYMENT_ITEM - Иной предмет расчета

  • isDiscountProhibited - Запретить скидки при продаже в розницу

  • packs - Массив упаковок

    • id - id сущности упаковки Необходимое
    • name - Название упаковки Необходимое
    • quantity - Количество товаров в упаковке Необходимое
    • barcode - Штрихкод упаковки

  • ppeType - Код вида номенклатурной классификации медицинских средств индивидуальной защиты (EAN-13)

Наименование вида номенклатурной классификации медицинских изделий Код вида номенклатурной классификации медицинских изделий (EAN-13)
маска лицевая для защиты дыхательных путей, многоразового использования 2400001323807
маска лицевая для защиты дыхательных путей, одноразового использования 2400003675805
респиратор общего применения 2400001807703
респиратор хирургический 2400001818303
респиратор хирургический антибактериальный 2400002186203
средство назальное для защиты от загрязненного воздуха, местного действия 2400001368105
перчатки смотровые (процедурные) из латекса гевеи, неопудренные, нестерильные 2400001225408
перчатки смотровые (процедурные) из латекса гевеи, опудренные 2400001225606
перчатки смотровые (процедурные) из латекса гевеи, неопудренные, стерильные 2400001226108
перчатки смотровые (процедурные) из полихлоропрена, неопудренные 2400001393503
перчатки смотровые (процедурные) нитриловые, неопудренные, нестерильные 2400001858309
перчатки смотровые (процедурные) нитриловые, опудренные 2400001858507
перчатки смотровые (процедурные) виниловые, неопудренные 2400002052805
перчатки смотровые (процедурные) виниловые, опудренные 2400002052904
перчатки смотровые (процедурные) из гваюлового латекса, неопудренные 2400002984502
перчатки смотровые (процедурные) из этиленвинилацетата, неопудренные, стерильные 2400003117107
перчатки смотровые (процедурные) из этиленвинилацетата, неопудренные, нестерильные 2400003117206
перчатки смотровые (процедурные) нитриловые, неопудренные, антибактериальные 2400003207907
перчатки смотровые (процедурные) полиизопреновые, неопудренные 2400003215308
перчатки смотровые (процедурные) нитриловые, неопудренные, стерильные 2400003297700
перчатки смотровые (процедурные) виниловые, неопудренные, стерильные 2400003356704
перчатки смотровые (процедурные) виниловые, опудренные, стерильные 2400003356803
перчатки смотровые (процедурные) из латекса гевеи, опудренные, стерильные 2400003433108
перчатки смотровые (процедурные) полиизопреновые, опудренные 2400003492303
перчатки смотровые (процедурные) из полихлоропрена, неопудренные, стерильные 2400003495700
перчатки смотровые (процедурные) из полихлоропрена, неопудренные, стерильные 2400003495809
перчатки смотровые (процедурные) нитриловые, опудренные, стерильные 2400003495908
перчатки смотровые (процедурные) полиизопреновые, неопудренные, стерильные 2400003496004
перчатки смотровые (процедурные) полиизопреновые, опудренные, стерильные 2400003496103
перчатки хирургические из латекса гевеи, неопудренные 2400001226306
перчатки хирургические из латекса гевеи, опудренные 2400001226405
перчатки хирургические из полихлоропрена, неопудренные 2400001393107
перчатки смотровые (процедурные) из полихлоропрена, опудренные 2400001393602
перчатки хирургические из блоксополимера стирола, неопудренные, антибактериальные 2400001565306
перчатки хирургические нитриловые, опудренные 2400001857203
перчатки хирургические нитриловые, неопудренные 2400001857005
перчатки хирургические полиизопреновые, неопудренные 2400002015909
перчатки хирургические полиизопреновые, неопудренные, антибактериальные 2400002016005
перчатки хирургические полиизопреновые, опудренные 2400002016104
перчатки хирургические из блоксополимера стирола, неопудренные 2400003161209
перчатки хирургические полимерно-композитные, неопудренные 2400003227806
перчатки хирургические полимерно-композитные, неопудренные 2400003237409
перчатки хирургические из латекса гевеи, неопудренные, антибактериальные 2400003263408
перчатки хирургические из гваюлового латекса, неопудренные 2400003356902
перчатки хирургические из полихлоропрена, опудренные 2400003356902
набор гигиенической одежды для посетителей 2400002886806
комбинезон гигиенический для посетителей 2400002886707

Поля модификаций

  • characteristics - Массив пар вида "Наименование характеристики:значение"

  • product - Основной товар

  • isSerialtrackable - учёт по серийным номерам Необходимое

Поля услуг

  • uom - Единица измерения услуги(строка)

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

  • paymentItemType - Признак предмета расчета

    • SERVICE - Услуга
    • WORK - Работа
    • PROVIDING_RID - Предоставление РИД
    • COMPOUND_PAYMENT_ITEM - Составной предмет расчета
    • ANOTHER_PAYMENT_ITEM - Иной предмет расчета

  • isDiscountProhibited - Запретить скидки при продаже в розницу

Поля комплектов

  • article - Артикул комплекта

  • uom - Единица измерения комплекта (строка)

  • vat - НДС

  • image - Изображение товара (объект)

    • href - Ссылка на изображение
    • miniature - Ссылка на миниатюру изображения
    • tiny - Ссылка на уменьшенную версию изображения

  • components - Компоненты комплекта, это список товаров/услуг/модификаций, который входят в состав комплекта. Компонентов у комплекта может быть от 1 до 10. Необходимое

    • meta - Метаданные сущности Необходимое
    • quantity - количество компонентов в комплекте.

  • trackingType - Тип маркируемой продукции

    • NOT_TRACKED - Без маркировки
    • TOBACCO - Тип маркировки “Табак”
    • SHOES - Тип маркировки “Обувь”
    • LP_CLOTHES - Тип маркировки “Одежда”
    • LP_LINENS - Тип маркировки “Постельное белье”
    • PERFUMERY - Тип маркировки “Духи и туалетная вода”
    • ELECTRONICS - Тип маркировки “Фотокамеры и лампы-вспышки”
    • TIRES - Тип маркировки “Шины и покрышки”
    • MILK - Тип маркировки “Молочная продукция”
    • WATER - Тип маркировки “Упакованная вода”
    • OTP - Тип маркировки “Альтернативная табачная продукция”
    • NCP - Тип маркировки “Никотиносодержащая продукция”
    • BEER_ALCOHOL - Тип маркировки “Пиво и слабоалкогольная продукция”
    • FOOD_SUPPLEMENT - Тип маркировки “Биологически активные добавки к пище”
    • SANITIZER - Тип маркировки “Антисептики”

  • tnved - Код ТН ВЭД

  • paymentItemType - Признак предмета расчета

    • GOOD - Товар
    • EXCISABLE_GOOD - Подакцизный товар
    • COMPOUND_PAYMENT_ITEM - Составной предмет расчета
    • ANOTHER_PAYMENT_ITEM - Иной предмет расчета

  • isDiscountProhibited - Запретить скидки при продаже в розницу

  • taxSystem - Код системы налогообложения.

  • partialDisposal - Флаг частичного выбытия.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Цены в рознице

Товары/услуги/комплекты в рознице отображаются со всеми типами цен (salePrices). Если тип цен не задан явно, то возвращается значение 0. Модификации в рознице отображаются с явно проставленными типами цен (salePrices). Если тип цен не задан явно, то будет отображаться цена родительского товара.

Папки

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Папки

GET https://online.moysklad.ru/api/posap/1.0/entity/productfolder
Responses200

Успешный запрос. Результат - список всех папок на учетной записи.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder",
    "mediaType": "application/json",
    "size": 3,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/276a6f50-7ffd-11e6-8a84-bae50000005c",
        "mediaType": "application/json",
        "type": "productfolder",
        "id": "276a6f50-7ffd-11e6-8a84-bae50000005c",
        "idType": "native"
      },
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
          "idType": "native"
        },
        "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
        "name": "Овощи",
        "namepath": "",
        "path": "/"
      },
      "id": "276a6f50-7ffd-11e6-8a84-bae50000005c",
      "name": "Цитрусовые",
      "namepath": "Овощи",
      "path": "/dbe2cf7f-7b5c-11e6-8a84-bae50000000e/"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/83528b98-7ffd-11e6-8a84-bae500000062",
        "mediaType": "application/json",
        "type": "productfolder",
        "id": "83528b98-7ffd-11e6-8a84-bae500000062",
        "idType": "native"
      },
      "productFolder": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/276a6f50-7ffd-11e6-8a84-bae50000005c",
          "mediaType": "application/json",
          "type": "productfolder",
          "id": "276a6f50-7ffd-11e6-8a84-bae50000005c",
          "idType": "native"
        },
        "productFolder": {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
            "mediaType": "application/json",
            "type": "productfolder",
            "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
            "idType": "native"
          }
        },
        "id": "276a6f50-7ffd-11e6-8a84-bae50000005c",
        "name": "Цитрусовые",
        "namepath": "Овощи",
        "path": "/dbe2cf7f-7b5c-11e6-8a84-bae50000000e/"
      },
      "id": "83528b98-7ffd-11e6-8a84-bae500000062",
      "name": "Оранжевые",
      "namepath": "Овощи/Цитрусовые",
      "path": "/dbe2cf7f-7b5c-11e6-8a84-bae50000000e/276a6f50-7ffd-11e6-8a84-bae50000005c/"
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
        "mediaType": "application/json",
        "type": "productfolder",
        "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
        "idType": "native"
      },
      "id": "dbe2cf7f-7b5c-11e6-8a84-bae50000000e",
      "name": "Овощи",
      "namepath": "",
      "path": "/"
    }
  ]
}

Получить все папки
GET/entity/productfolder

Запрос на получение всех папок на учётной записи.

Атрибуты ответа

  • meta - метаданные папки Необходимое

  • productFolder - ссылка на родительскую папку

    • meta - метаданные папки Необходимое (если пришло родительское поле)
    • productFolder - ссылка на родительскую папку
    • id - id папки Необходимое (если пришло родительское поле)
    • name - наименование папки Необходимое (если пришло родительское поле)
    • namepath - путь к данной папке, состоящий из имён родительских папок Необходимое (если пришло родительское поле)
    • path - путь к данной папке, состоящий из id родительских папок Необходимое (если пришло родительское поле)

  • id - id папки Необходимое

  • name - наименование папки Необходимое

  • namepath - путь к данной папке, состоящий из имён родительских папок Необходимое

  • path - путь к данной папке, состоящий из id родительских папок Необходимое

Покупатели

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Покупатели

GET https://online.moysklad.ru/api/posap/1.0/entity/counterparty
Responses200

Успешный запрос. Результат - JSON представление списка контрагентов.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty",
    "mediaType": "application/json",
    "size": 6,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
        "idType": "native"
      },
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "version": 0,
      "updated": "2016-09-15 13:49:43",
      "name": "OOOCompany",
      "externalCode": "qKQuM-6ijqMFB5TemvZxi1",
      "companyType": "legal",
      "tags": [],
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d1fe143-7b1d-11e6-8a84-bae500000054",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d1fe143-7b1d-11e6-8a84-bae500000054",
        "idType": "native"
      },
      "id": "5d1fe143-7b1d-11e6-8a84-bae500000054",
      "version": 0,
      "updated": "2016-09-15 11:21:13",
      "name": "ООО \"Поставщик\"",
      "externalCode": "8DLiwCbIhvJz3TSNC2h1G3",
      "companyType": "legal",
      "legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
      "legalAddress": "г.Москва, ул.Строителей, д.12",
      "inn": "7736570901",
      "kpp": "773601001",
      "tags": [],
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d201705-7b1d-11e6-8a84-bae500000056",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d201705-7b1d-11e6-8a84-bae500000056",
        "idType": "native"
      },
      "id": "5d201705-7b1d-11e6-8a84-bae500000056",
      "version": 0,
      "updated": "2016-09-15 11:21:13",
      "name": "ООО \"Покупатель\"",
      "externalCode": "grYJWYhkheEmr3aNP53-72",
      "companyType": "legal",
      "legalTitle": "Общество с ограниченной ответственностью \"Покупатель\"",
      "legalAddress": "г.Москва, ул.Строителей, д.11",
      "inn": "7736570902",
      "kpp": "773601002",
      "tags": [],
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d444290-7b1d-11e6-8a84-bae50000005e",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d444290-7b1d-11e6-8a84-bae50000005e",
        "idType": "native"
      },
      "id": "5d444290-7b1d-11e6-8a84-bae50000005e",
      "version": 10,
      "updated": "2016-09-15 11:21:13",
      "name": "Розничный покупатель",
      "externalCode": "xprOCvL2gPZjzlYwqzsvw3",
      "companyType": "legal",
      "tags": [],
      "salesAmount": 18720
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "688bd078-800c-11e6-8a84-bae5000000a2",
        "idType": "native"
      },
      "id": "688bd078-800c-11e6-8a84-bae5000000a2",
      "version": 4,
      "updated": "2016-09-21 18:05:01",
      "name": "АО компания-банк",
      "description": "Ключевой партнёр",
      "code": "almost-alfa-code",
      "externalCode": "6AWY7U4biGxP-HFAmEN0l3",
      "companyType": "entrepreneur",
      "legalTitle": "АКЦИОНЕРНОЕ ОБЩЕСТВО \"компания-банк\"",
      "legalAddress": "г Можайск, ул Недокаланчевская, д 26.99",
      "actualAddress": "г Можайск, ул Перекаланчевская, д 27.01",
      "inn": "7728178971",
      "okpo": "3519251242513",
      "ogrnip": "12412412",
      "certificateNumber": "в21421412",
      "certificateDate": "2016-09-01 00:00:00",
      "email": "aoalmost@bank.ru",
      "phone": "+7 666 555 444 333",
      "fax": "123321",
      "tags": [],
      "discounts": [
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/941e8ce7-7b1d-11e6-8a84-bae500000111",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 30000
        },
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/98af408c-7fdc-11e6-8a84-bae50000003c",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 1000
        },
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/fbd3a1b7-7fdd-11e6-8a84-bae500000047",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "fbd3a1b7-7fdd-11e6-8a84-bae500000047",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 1000
        }
      ],
      "discountCardNumber": "6",
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/801ee966-7b1d-11e6-8a84-bae5000000fd",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "801ee966-7b1d-11e6-8a84-bae5000000fd",
        "idType": "native"
      },
      "id": "801ee966-7b1d-11e6-8a84-bae5000000fd",
      "version": 3,
      "updated": "2016-09-21 12:21:54",
      "name": "Контрагент со скидкой",
      "externalCode": "uI93KJojjZk7F-WU9eJfr1",
      "companyType": "legal",
      "tags": [],
      "discounts": [
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/941e8ce7-7b1d-11e6-8a84-bae500000111",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 0
        },
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/98af408c-7fdc-11e6-8a84-bae50000003c",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 10000
        }
      ],
      "salesAmount": 150000
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d444290-7b1d-11e6-8a84-bae50000005d",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d444290-7b1d-11e6-8a84-bae50000005d",
        "idType": "native"
      },
      "id": "5d444290-7b1d-11e6-8a84-bae50000005d",
      "version": 10,
      "updated": "2023-07-14 11:21:13",
      "name": "Покупатель женщина",
      "externalCode": "xprOCvL2gP",
      "companyType": "individual",
      "tags": [],
      "salesAmount": 0,
      "sex": "FEMALE",
      "birthDate": "2023-07-14 00:00:00",
      "legalFirstName": "first",
      "legalMiddleName": "middle",
      "legalLastName": "last"
    }
  ]
}

Получить Покупателей
GET/entity/counterparty

Запрос на получение списка всех контрагентов.

Параметры запроса

  • offsetId - Смещение

  • limit - Максимальное возвращаемое кол-во

  • direction - Направление следующей страницы поиска

  • search - Строка для поиска. Возвращаемые контрагенты должны содержать соответствующую подстроку в одном из полей: name, email, phone, discountCardNumber

Атрибуты ответа:

Служебные

  • meta - внешний уникальный идентификатор в формате метаданных (мета с syncId) Необходимое

  • id - ID в формате UUID Необходимое

  • syncId - ID синхронизации

  • version - Версия сущности. Изменяется при обновлении/удалении Контрагента Необходимое

  • updated - Момент последнего обновления Контрагента Необходимое

  • externalCode - Внешний код Контрагента Необходимое

Основные данные

  • name - Имя Контрагента Необходимое

  • code - Код Контрагента

  • description - Описание Контрагента

  • actualAddress -Фактический адрес Контрагента

  • tags - Тэги (массив) Необходимое

Данные контрагента

  • companyType - Тип Контрагента. Необходимое [Юридическое лицо, Индивидуальный предприниматель, Физическое лицо].
Тип контрагента Значение поля companyType
Юридическое лицо legal
Индивидуальный предприниматель entrepreneur
Физическое лицо individual

  • legalTitle - Полное наименование Контрагента

  • legalAddress - Юридический адрес Контрагента

  • inn - ИНН

  • kpp - КПП

  • ogrn - ОГРН

  • ogrnip - ОГРНИП

  • okpo - ОКПО

  • certificateNumber - Номер свидетельства

  • certificateDate - Дата свидетельства

Контактные данные

  • email - Адрес электронной почты

  • phone - Номер городского телефона

  • fax - Номер факса

Данные о скидках

  • discounts - Массив объектов-скидок, действующих на данного контрагента.

    • discount - Скидка
      • meta - метаданные скидки
      • personalDiscount - процент персональной скидки (если тип - персональная скидка)
      • salesAmountCorrection - Коррекция

  • discountCardNumber - Номер дисконтной карты

  • salesAmount - Сумма продаж контрагента Необходимое

  • bonusProgram - Метаданные активной бонусной программы

  • bonusPoints - Бонусные баллы по активной бонусной программе

  • legalFirstName - Имя контрагента

  • legalMiddleName - Отчество контрагента

  • legalLastName - Фамилия контрагента

  • sex - Пол контрагента [Мужской, Женский].

Пол контрагента Значение поля sex
Мужской MALE
Женский FEMALE
  • birthDate - Дата рождения контрагента

Покупатели

POST https://online.moysklad.ru/api/posap/1.0/entity/counterparty/detail
RequestsПример

Пример body запроса для получения информации по контрагенту.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2",
    "mediaType": "application/json",
    "type": "counterparty",
    "id": "688bd078-800c-11e6-8a84-bae5000000a2",
    "idType": "native"
  },
  "id": "688bd078-800c-11e6-8a84-bae5000000a2",
  "syncId": "688bd078-800c-11e6-8a84-bae5000000a3",
  "version": 4,
  "updated": "2016-09-21 18:05:01",
  "name": "АО компания-банк",
  "description": "Ключевой партнёр",
  "code": "almost-alfa-code",
  "externalCode": "6AWY7U4biGxP-HFAmEN0l3",
  "companyType": "entrepreneur",
  "legalTitle": "АКЦИОНЕРНОЕ ОБЩЕСТВО \"компания-банк\"",
  "legalAddress": "г Можайск, ул Недокаланчевская, д 26.99",
  "actualAddress": "г Можайск, ул Перекаланчевская, д 27.01",
  "inn": "7728178971",
  "okpo": "3519251242513",
  "ogrnip": "12412412",
  "certificateNumber": "в21421412",
  "certificateDate": "2016-09-01 00:00:00",
  "email": "aoalmost@bank.ru",
  "phone": "+7 666 555 444 333",
  "fax": "123321",
  "tags": [],
  "discounts": [
    {
      "discount": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/941e8ce7-7b1d-11e6-8a84-bae500000111",
          "mediaType": "application/json",
          "type": "accumulationdiscount",
          "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
          "idType": "native"
        }
      },
      "salesAmountCorrection": 30000
    },
    {
      "discount": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/98af408c-7fdc-11e6-8a84-bae50000003c",
          "mediaType": "application/json",
          "type": "accumulationdiscount",
          "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
          "idType": "native"
        }
      },
      "salesAmountCorrection": 1000
    },
    {
      "discount": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/fbd3a1b7-7fdd-11e6-8a84-bae500000047",
          "mediaType": "application/json",
          "type": "accumulationdiscount",
          "id": "fbd3a1b7-7fdd-11e6-8a84-bae500000047",
          "idType": "native"
        }
      },
      "salesAmountCorrection": 1000
    }
  ],
  "discountCardNumber": "6",
  "salesAmount": 0
}
Responses200

Успешный запрос. Результат - JSON представление данных контрагента.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty",
    "mediaType": "application/json",
    "size": 6,
    "limit": 1000,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
        "idType": "native"
      },
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "version": 0,
      "updated": "2016-09-15 13:49:43",
      "name": "OOOCompany",
      "externalCode": "qKQuM-6ijqMFB5TemvZxi1",
      "companyType": "legal",
      "tags": [],
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d1fe143-7b1d-11e6-8a84-bae500000054",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d1fe143-7b1d-11e6-8a84-bae500000054",
        "idType": "native"
      },
      "id": "5d1fe143-7b1d-11e6-8a84-bae500000054",
      "version": 0,
      "updated": "2016-09-15 11:21:13",
      "name": "ООО \"Поставщик\"",
      "externalCode": "8DLiwCbIhvJz3TSNC2h1G3",
      "companyType": "legal",
      "legalTitle": "Общество с ограниченной ответственностью \"Поставщик\"",
      "legalAddress": "г.Москва, ул.Строителей, д.12",
      "inn": "7736570901",
      "kpp": "773601001",
      "tags": [],
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d201705-7b1d-11e6-8a84-bae500000056",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d201705-7b1d-11e6-8a84-bae500000056",
        "idType": "native"
      },
      "id": "5d201705-7b1d-11e6-8a84-bae500000056",
      "version": 0,
      "updated": "2016-09-15 11:21:13",
      "name": "ООО \"Покупатель\"",
      "externalCode": "grYJWYhkheEmr3aNP53-72",
      "companyType": "legal",
      "legalTitle": "Общество с ограниченной ответственностью \"Покупатель\"",
      "legalAddress": "г.Москва, ул.Строителей, д.11",
      "inn": "7736570902",
      "kpp": "773601002",
      "tags": [],
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d444290-7b1d-11e6-8a84-bae50000005e",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d444290-7b1d-11e6-8a84-bae50000005e",
        "idType": "native"
      },
      "id": "5d444290-7b1d-11e6-8a84-bae50000005e",
      "version": 10,
      "updated": "2016-09-15 11:21:13",
      "name": "Розничный покупатель",
      "externalCode": "xprOCvL2gPZjzlYwqzsvw3",
      "companyType": "legal",
      "tags": [],
      "salesAmount": 18720
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "688bd078-800c-11e6-8a84-bae5000000a2",
        "idType": "native"
      },
      "id": "688bd078-800c-11e6-8a84-bae5000000a2",
      "version": 4,
      "updated": "2016-09-21 18:05:01",
      "name": "АО компания-банк",
      "description": "Ключевой партнёр",
      "code": "almost-alfa-code",
      "externalCode": "6AWY7U4biGxP-HFAmEN0l3",
      "companyType": "entrepreneur",
      "legalTitle": "АКЦИОНЕРНОЕ ОБЩЕСТВО \"компания-банк\"",
      "legalAddress": "г Можайск, ул Недокаланчевская, д 26.99",
      "actualAddress": "г Можайск, ул Перекаланчевская, д 27.01",
      "inn": "7728178971",
      "okpo": "3519251242513",
      "ogrnip": "12412412",
      "certificateNumber": "в21421412",
      "certificateDate": "2016-09-01 00:00:00",
      "email": "aoalmost@bank.ru",
      "phone": "+7 666 555 444 333",
      "fax": "123321",
      "tags": [],
      "discounts": [
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/941e8ce7-7b1d-11e6-8a84-bae500000111",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 30000
        },
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/98af408c-7fdc-11e6-8a84-bae50000003c",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 1000
        },
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/fbd3a1b7-7fdd-11e6-8a84-bae500000047",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "fbd3a1b7-7fdd-11e6-8a84-bae500000047",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 1000
        }
      ],
      "discountCardNumber": "6",
      "salesAmount": 0
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/801ee966-7b1d-11e6-8a84-bae5000000fd",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "801ee966-7b1d-11e6-8a84-bae5000000fd",
        "idType": "native"
      },
      "id": "801ee966-7b1d-11e6-8a84-bae5000000fd",
      "version": 3,
      "updated": "2016-09-21 12:21:54",
      "name": "Контрагент со скидкой",
      "externalCode": "uI93KJojjZk7F-WU9eJfr1",
      "companyType": "legal",
      "tags": [],
      "discounts": [
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/941e8ce7-7b1d-11e6-8a84-bae500000111",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "941e8ce7-7b1d-11e6-8a84-bae500000111",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 0
        },
        {
          "discount": {
            "meta": {
              "href": "https://online.moysklad.ru/api/posap/1.0/entity/accumulationdiscount/98af408c-7fdc-11e6-8a84-bae50000003c",
              "mediaType": "application/json",
              "type": "accumulationdiscount",
              "id": "98af408c-7fdc-11e6-8a84-bae50000003c",
              "idType": "native"
            }
          },
          "salesAmountCorrection": 10000
        }
      ],
      "salesAmount": 150000
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/5d444290-7b1d-11e6-8a84-bae50000005d",
        "mediaType": "application/json",
        "type": "counterparty",
        "id": "5d444290-7b1d-11e6-8a84-bae50000005d",
        "idType": "native"
      },
      "id": "5d444290-7b1d-11e6-8a84-bae50000005d",
      "version": 10,
      "updated": "2023-07-14 11:21:13",
      "name": "Покупатель женщина",
      "externalCode": "xprOCvL2gP",
      "companyType": "individual",
      "tags": [],
      "salesAmount": 0,
      "sex": "FEMALE",
      "birthDate": "2023-07-14 00:00:00",
      "legalFirstName": "first",
      "legalMiddleName": "middle",
      "legalLastName": "last"
    }
  ]
}

Получить бонусные баллы Покупателя
POST/entity/counterparty/detail

Запрос на получение бонусных баллов контрагента. Необходимо передать объект, полученный из метода GET /entity/counterparty. Бонусные баллы возвращаются для каждого контрагента в отдельном запросе на получение баллов.

Параметры запроса

  • meta - внешний уникальный идентификатор в формате метаданных (мета с syncId) Необходимое

  • id - ID в формате UUID Необходимое

  • syncId - ID синхронизации

  • version - Версия сущности. Изменяется при обновлении/удалении Контрагента Необходимое

  • updated - Момент последнего обновления Контрагента Необходимое

  • externalCode - Внешний код Контрагента Необходимое

Основные данные

  • name - Имя Контрагента Необходимое

  • code - Код Контрагента

  • description - Описание Контрагента

  • actualAddress -Фактический адрес Контрагента

  • tags - Тэги (массив) Необходимое

Данные контрагента

  • companyType - Тип Контрагента. Необходимое [Юридическое лицо, Индивидуальный предприниматель, Физическое лицо].
Тип контрагента Значение поля companyType
Юридическое лицо legal
Индивидуальный предприниматель entrepreneur
Физическое лицо individual

  • legalTitle - Полное наименование Контрагента

  • legalAddress - Юридический адрес Контрагента

  • inn - ИНН

  • kpp - КПП

  • ogrn - ОГРН

  • ogrnip - ОГРНИП

  • okpo - ОКПО

  • certificateNumber - Номер свидетельства

  • certificateDate - Дата свидетельства

Контактные данные

  • email - Адрес электронной почты

  • phone - Номер городского телефона

  • fax - Номер факса

Данные о скидках

  • discounts - Массив объектов-скидок, действующих на данного контрагента.

    • discount - Скидка
      • meta - метаданные скидки
      • personalDiscount - процент персональной скидки (если тип - персональная скидка)
      • salesAmountCorrection - Коррекция

  • discountCardNumber - Номер дисконтной карты

  • salesAmount - Сумма продаж контрагента Необходимое

  • legalFirstName - Имя контрагента

  • legalMiddleName - Отчество контрагента

  • legalLastName - Фамилия контрагента

  • sex - Пол контрагента [Мужской, Женский].

Пол контрагента Значение поля sex
Мужской MALE
Женский FEMALE
  • birthDate - Дата рождения контрагента

Атрибуты ответа:

Служебные

  • meta - внешний уникальный идентификатор в формате метаданных (мета с syncId) Необходимое

  • id - ID в формате UUID Необходимое

  • syncId - ID синхронизации

  • version - Версия сущности. Изменяется при обновлении/удалении Контрагента Необходимое

  • updated - Момент последнего обновления Контрагента Необходимое

  • externalCode - Внешний код Контрагента Необходимое

Основные данные

  • name - Имя Контрагента Необходимое

  • code - Код Контрагента

  • description - Описание Контрагента

  • actualAddress -Фактический адрес Контрагента

  • tags - Тэги (массив) Необходимое

Данные контрагента

  • companyType - Тип Контрагента. Необходимое [Юридическое лицо, Индивидуальный предприниматель, Физическое лицо].
Тип контрагента Значение поля companyType
Юридическое лицо legal
Индивидуальный предприниматель entrepreneur
Физическое лицо individual

  • legalTitle - Полное наименование Контрагента

  • legalAddress - Юридический адрес Контрагента

  • inn - ИНН

  • kpp - КПП

  • ogrn - ОГРН

  • ogrnip - ОГРНИП

  • okpo - ОКПО

  • certificateNumber - Номер свидетельства

  • certificateDate - Дата свидетельства

Контактные данные

  • email - Адрес электронной почты

  • phone - Номер городского телефона

  • fax - Номер факса

Данные о скидках

  • discounts - Массив объектов-скидок, действующих на данного контрагента.

    • discount - Скидка
      • meta - метаданные скидки
      • personalDiscount - процент персональной скидки (если тип - персональная скидка)
      • salesAmountCorrection - Коррекция

  • discountCardNumber - Номер дисконтной карты

  • salesAmount - Сумма продаж контрагента Необходимое

  • bonusProgram - Метаданные активной бонусной программы

  • bonusPoints - Бонусные баллы по активной бонусной программе

  • legalFirstName - Имя контрагента

  • legalMiddleName - Отчество контрагента

  • legalLastName - Фамилия контрагента

  • sex - Пол контрагента [Мужской, Женский].

Пол контрагента Значение поля sex
Мужской MALE
Женский FEMALE
  • birthDate - Дата рождения контрагента

Заказы покупателей

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Заказы покупателей

GET https://online.moysklad.ru/api/posap/1.0/entity/customerorder
Responses200

Успешный запрос. Результат - JSON представление списка Заказов покупателей.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder",
    "mediaType": "application/json",
    "size": 1,
    "limit": 100,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/0f175046-dbca-11e6-5bed-427b00000079",
        "mediaType": "application/json",
        "type": "customerorder",
        "id": "0f175046-dbca-11e6-5bed-427b00000079",
        "idType": "native"
      },
      "id": "0f175046-dbca-11e6-5bed-427b00000079",
      "name": "00001",
      "description": "2222222222222",
      "moment": "2017-01-16 11:59:00",
      "vatEnabled": true,
      "vatIncluded": true,
      "deliveryPlannedMoment": "2017-02-01 17:12:00",
      "state": {
        "name": "Новый",
        "color": 15106326,
        "type": "Regular"
      },
      "positions": [
        {
          "assortment": {
            "meta": {
              "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000003",
              "mediaType": "application/json",
              "type": "product",
              "id": "d90cda3b-1f6c-11e7-8a7f-40d000000003",
              "idType": "native"
            },
            "name": "good1",
            "code": "00034",
            "uom": "шт",
            "barcodes": [
              "2000000000367"
            ],
            "salePrices": [
              {
                "value": 6000,
                "priceType": "Цена продажи"
              },
              {
                "value": 4000,
                "priceType": "Цена распродажи"
              }
            ],
            "soldByWeight": false,
            "onTap": false,
            "isSerialTrackable": false,
            "paymentItemType": "GOOD",
            "isDiscountProhibited": false
          },
          "quantity": 1,
          "price": 0,
          "vat": 0,
          "vatEnabled": false,
          "discount": 0,
          "reserve": 0
        },
        {
          "assortment": {
            "meta": {
              "href": "http://online.moysklad.ru/api/posap/1.0/entity/variant/cca27551-5cc3-11e7-6a80-332a000000a4",
              "mediaType": "application/json",
              "type": "variant",
              "id": "cca27551-5cc3-11e7-6a80-332a000000a4",
              "idType": "native"
            },
            "name": "good1 (variant)",
            "code": "00035",
            "uom": "шт",
            "barcodes": [
              "2000000000369"
            ],
            "salePrices": [
              {
                "value": 6000,
                "priceType": "Цена продажи"
              },
              {
                "value": 5000,
                "priceType": "Цена распродажи"
              }
            ],
            "soldByWeight": false,
            "onTap": false,
            "isSerialTrackable": false,
            "paymentItemType": "ANOTHER_PAYMENT_ITEM",
            "isDiscountProhibited": false
          },
          "quantity": 10,
          "price": 0,
          "vat": 0,
          "vatEnabled": false,
          "discount": 0,
          "reserve": 0,
          "pack": {
            "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
            "name": "ящ",
            "quantity": 10,
            "barcode": "2000000000016"
          }
        },
        {
          "assortment": {
            "meta": {
              "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000103",
              "mediaType": "application/json",
              "type": "product",
              "id": "d90cda3b-1f6c-11e7-8a7f-40d000000103",
              "idType": "native"
            },
            "name": "mask",
            "code": "00134",
            "uom": "шт",
            "barcodes": [
              "2000000023367"
            ],
            "salePrices": [
              {
                "value": 3500,
                "priceType": "Цена продажи"
              }
            ],
            "soldByWeight": false,
            "onTap": false,
            "isSerialTrackable": false,
            "paymentItemType": "GOOD",
            "isDiscountProhibited": false,
            "ppeType": "2400001323807"
          },
          "quantity": 1,
          "price": 0,
          "vat": 0,
          "vatEnabled": false,
          "discount": 0,
          "reserve": 0
        }
      ],
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/90fdbe2f-d973-11e6-5bed-427b00000056",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "90fdbe2f-d973-11e6-5bed-427b00000056",
          "idType": "native"
        },
        "name": "ООО \"Покупатель\""
      },
      "prepayments": [
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
            "mediaType": "application/json",
            "type": "prepayment",
            "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
            "idType": "native"
          },
          "name": "00010"
        },
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
            "mediaType": "application/json",
            "type": "prepayment",
            "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
            "idType": "native"
          },
          "name": "00011"
        }
      ],
      "paidInCash": 123,
      "paidNoCash": 222,
      "paidByQr": 0,
      "shippedSum": 111
    }
  ]
}

Получить Заказы покупателей
GET/entity/customerorder

Запрос на получение списка Заказов покупателей, соответствующих складу и организации точки продаж. Не выгружаются Заказы с сериями, алкогольными товарами, непроведенные заказы, а также заказы без позиций и заказы, у которых более 1000 позиций.

Атрибуты ответа:

Служебные

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • id - ID в формате UUID Необходимое

Основные данные

  • name - Имя Необходимое

  • description - Описание

  • moment - Дата Необходимое

  • vatEnabled - Учитывается ли НДС Необходимое

  • vatIncluded - Включен ли НДС в цену Необходимое

  • deliveryPlannedMoment - Планируемая дата отгрузки

  • state - Статус

  • positions - Ссылка на позиции в формате метаданных Необходимое

  • agent - Ссылка на покупателя в формате метаданных (Если заказ назначен на стандартного розничный покупателя, то это поле не придёт в составе заказа)

  • paidInCash - Оплачено наличными по заказу

  • paidNoCash - Оплачено картой по заказу

  • paidByQr - Оплачено по QR-коду по заказу

  • shippedSum - Отгружено

  • prepayments - Предоплаты связанные с заказом покупателя

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/комплектов. Объект позиции Заказа содержит следующие поля:

  • assortment - Ссылка на товар/услугу/модификацию/комплект (мета), которую представляет собой позиция Необходимое

  • quantity - Количество товаров/услуг/модификаций/комплектов данного вида в позиции Необходимое

  • price - Цена товаров/услуг/модификаций/комплекта в копейках Необходимое

  • vat - НДС, которым облагается текущая позиция Необходимое

  • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • discount - Процент скидки или наценки Необходимое

  • reserve - Резерв данной позиции Необходимое

  • pack - Упаковка

    • id - id сущности упаковки Необходимое
    • name - Название упаковки Необходимое
    • quantity - Количество товаров в упаковке Необходимое
    • barcode - Штрихкод упаковки

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Статус Заказа покупателя

Объект статуса Заказа содержит следующие поля:

  • name - Наименование Необходимое

  • color - Цвет в цветовом пространстве ARGB Необходимое

  • type - Тип. Возможные значения: [Regular(обычный), Successful(Финальный положительный), Unsuccessful(Финальный отрицательный)] Необходимое

Покупатель Заказа покупателя

Объект покупателя Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Предоплаты Заказа покупателя

Объект предоплаты Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Настройки, влияющие на выдачу заказов:

У точки продаж в основном приложении есть настройка: “Выгружать только заказы со статусами”, которая влияет на выдачу заказов. Если в этой настройке указаны статусы, то, при запросе заказов, будут возвращены только заказы с указанными статусами. Если статусы не указаны, будут выгружаться заказы со всеми статусами в т.ч. пустыми.

Заказы покупателей

GET https://online.moysklad.ru/api/posap/1.0/entity/customerorder/7944ef04-f831-11e5-7a69-971500188b19
Responses200

Успешный запрос. Результат - JSON представление списка Заказов покупателей.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/0f175046-dbca-11e6-5bed-427b00000079",
    "mediaType": "application/json",
    "type": "customerorder",
    "id": "0f175046-dbca-11e6-5bed-427b00000079",
    "idType": "native"
  },
  "id": "0f175046-dbca-11e6-5bed-427b00000079",
  "name": "00001",
  "description": "2222222222222",
  "moment": "2017-01-16 11:59:00",
  "vatEnabled": true,
  "vatIncluded": true,
  "deliveryPlannedMoment": "2017-02-01 17:12:00",
  "state": {
    "name": "Новый",
    "color": 15106326,
    "type": "Regular"
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000003",
          "mediaType": "application/json",
          "type": "product",
          "id": "d90cda3b-1f6c-11e7-8a7f-40d000000003",
          "idType": "native"
        },
        "name": "good1",
        "code": "00034",
        "uom": "шт",
        "barcodes": [
          "2000000000367"
        ],
        "salePrices": [
          {
            "value": 6000,
            "priceType": "Цена продажи"
          },
          {
            "value": 4000,
            "priceType": "Цена распродажи"
          }
        ],
        "soldByWeight": false,
        "onTap": false,
        "isSerialTrackable": false,
        "paymentItemType": "GOOD",
        "isDiscountProhibited": false
      },
      "quantity": 1,
      "price": 0,
      "vat": 0,
      "vatEnabled": false,
      "discount": 0,
      "reserve": 0
    },
    {
      "assortment": {
        "meta": {
          "href": "http://online.moysklad.ru/api/posap/1.0/entity/variant/cca27551-5cc3-11e7-6a80-332a000000a4",
          "mediaType": "application/json",
          "type": "variant",
          "id": "cca27551-5cc3-11e7-6a80-332a000000a4",
          "idType": "native"
        },
        "name": "good1 (variant)",
        "code": "00035",
        "uom": "шт",
        "barcodes": [
          "2000000000369"
        ],
        "salePrices": [
          {
            "value": 6000,
            "priceType": "Цена продажи"
          },
          {
            "value": 5000,
            "priceType": "Цена распродажи"
          }
        ],
        "soldByWeight": false,
        "onTap": false,
        "isSerialTrackable": false,
        "paymentItemType": "ANOTHER_PAYMENT_ITEM",
        "isDiscountProhibited": false
      },
      "quantity": 10,
      "price": 0,
      "vat": 0,
      "vatEnabled": false,
      "discount": 0,
      "reserve": 0,
      "pack": {
        "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
        "name": "ящ",
        "quantity": 10,
        "barcode": "2000000000016"
      }
    },
    {
      "assortment": {
        "meta": {
          "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000103",
          "mediaType": "application/json",
          "type": "product",
          "id": "d90cda3b-1f6c-11e7-8a7f-40d000000103",
          "idType": "native"
        },
        "name": "mask",
        "code": "00134",
        "uom": "шт",
        "barcodes": [
          "2000000023367"
        ],
        "salePrices": [
          {
            "value": 3500,
            "priceType": "Цена продажи"
          }
        ],
        "soldByWeight": false,
        "onTap": false,
        "isSerialTrackable": false,
        "paymentItemType": "GOOD",
        "isDiscountProhibited": false,
        "ppeType": "2400001323807"
      },
      "quantity": 1,
      "price": 0,
      "vat": 0,
      "vatEnabled": false,
      "discount": 0,
      "reserve": 0
    }
  ],
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/90fdbe2f-d973-11e6-5bed-427b00000056",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "90fdbe2f-d973-11e6-5bed-427b00000056",
      "idType": "native"
    },
    "name": "ООО \"Покупатель\""
  },
  "prepayments": [
    {
      "meta": {
        "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
        "mediaType": "application/json",
        "type": "prepayment",
        "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
        "idType": "native"
      },
      "name": "00010"
    },
    {
      "meta": {
        "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
        "mediaType": "application/json",
        "type": "prepayment",
        "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
        "idType": "native"
      },
      "name": "00011"
    }
  ],
  "paidInCash": 123,
  "paidNoCash": 222,
  "paidByQr": 0,
  "shippedSum": 111
}

Получить Заказ покупателя
GET/entity/customerorder/{id}

Запрос на получение заказа для точки продаж.

Атрибуты ответа:

Служебные

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • id - ID в формате UUID Необходимое

Основные данные

  • name - Имя Необходимое

  • description - Описание

  • moment - Дата Необходимое

  • vatEnabled - Учитывается ли НДС Необходимое

  • vatIncluded - Включен ли НДС в цену Необходимое

  • deliveryPlannedMoment - Планируемая дата отгрузки

  • state - Статус

  • positions - Ссылка на позиции в формате метаданных Необходимое

  • agent - Ссылка на покупателя в формате метаданных (Если заказ назначен на стандартного розничный покупателя, то это поле не придёт в составе заказа)

  • paidInCash - Оплачено наличными по заказу

  • paidNoCash - Оплачено картой по заказу

  • paidByQr - Оплачено по QR-коду по заказу

  • shippedSum - Отгружено

  • prepayments - Предоплаты связанные с заказом покупателя

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/комплектов. Объект позиции Заказа содержит следующие поля:

  • assortment - Ссылка на товар/услугу/модификацию/комплект (мета), которую представляет собой позиция Необходимое

  • quantity - Количество товаров/услуг/модификаций/комплектов данного вида в позиции Необходимое

  • price - Цена товаров/услуг/модификаций/комплекта в копейках Необходимое

  • vat - НДС, которым облагается текущая позиция Необходимое

  • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • discount - Процент скидки или наценки Необходимое

  • reserve - Резерв данной позиции Необходимое

  • pack - Упаковка

    • id - id сущности упаковки Необходимое
    • name - Название упаковки Необходимое
    • quantity - Количество товаров в упаковке Необходимое
    • barcode - Штрихкод упаковки

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Статус Заказа покупателя

Объект статуса Заказа содержит следующие поля:

  • name - Наименование Необходимое

  • color - Цвет в цветовом пространстве ARGB Необходимое

  • type - Тип. Возможные значения: [Regular(обычный), Successful(Финальный положительный), Unsuccessful(Финальный отрицательный)] Необходимое

Покупатель Заказа покупателя

Объект покупателя Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Предоплаты Заказа покупателя

Объект предоплаты Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Настройки, влияющие на выдачу заказов:

У точки продаж в основном приложении есть настройка: “Выгружать только заказы со статусами”, которая влияет на выдачу заказов. Если в этой настройке указаны статусы, то, при запросе заказов, будут возвращены только заказы с указанными статусами. Если статусы не указаны, будут выгружаться заказы со всеми статусами в т.ч. пустыми.

URI Параметры
СкрытьПоказать
id
string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Заказа покупателя

Заказы покупателей

POST https://online.moysklad.ru/api/posap/1.0/entity/customerorder
RequestsПример 1

Пример создания нового заказа покупателя.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "moment": "2018-09-06 21:41:46",
  "description": "Описание заказа",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/syncid/f085d67e-6eae-11e6-8a84-bc520403352a"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "taxSystem": "SIMPLIFIED_TAX_SYSTEM_INCOME"
}
Responses201
This response has no content.

Создать заказ покупателя
POST/entity/customerorder

Запрос на создание нового заказа покупателя.

Обязательные поля для создания заказа:

  • meta - Метаданные

  • agent - Ссылка на контрагента.

В случае, если не будет передано поле name - оно будет автоматически присвоено на сервере. После создания, заказу будет выставлена Организация, указанная в настройках точки продаж.

Атрибуты запроса

  • taxSystem - Код системы налогообложения.
Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Серийные номера

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Серийные номера

GET https://online.moysklad.ru/api/posap/1.0/entity/sn
Responses200

Успешный запрос. Результат - JSON представление списка серийных номеров.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn",
    "mediaType": "application/json",
    "size": 4,
    "limit": 100,
    "offsetId": "00000000-0000-0000-0000-000000000000",
    "direction": "forward"
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/dcb887fa-2ff8-11e7-8a84-bae500000005",
        "mediaType": "application/json",
        "type": "sn",
        "id": "dcb887fa-2ff8-11e7-8a84-bae500000005",
        "idType": "native"
      },
      "name": "12322678909292929292",
      "code": "123aa2c34eg566",
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/b7fb5459-2a83-11e7-9464-e4de00000026",
          "mediaType": "application/json",
          "type": "product",
          "id": "b7fb5459-2a83-11e7-9464-e4de00000026",
          "idType": "native"
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/dcb887fa-2ff8-11e7-8a84-bae500000005",
        "mediaType": "application/json",
        "type": "sn",
        "id": "dcb887fa-2ff8-11e7-8a84-bae500000005",
        "idType": "native"
      },
      "name": "12345678909292929292",
      "code": "12345678909292929292",
      "description": "Описание серийного номера",
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/bbc50755-2a83-11e7-9464-e4de0000002e",
          "mediaType": "application/json",
          "type": "product",
          "id": "bbc50755-2a83-11e7-9464-e4de0000002e",
          "idType": "native"
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/dcb887fa-2ff8-11e7-8a84-bae500000005",
        "mediaType": "application/json",
        "type": "sn",
        "id": "dcb887fa-2ff8-11e7-8a84-bae500000005",
        "idType": "native"
      },
      "name": "123456665556329292926",
      "code": "123456789092777629292",
      "description": "Серийный номер продукта",
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/bbc82552-2a83-11e7-9464-e4de00000032",
          "mediaType": "application/json",
          "type": "product",
          "id": "bbc82552-2a83-11e7-9464-e4de00000032",
          "idType": "native"
        }
      }
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/eb21663a-2b2b-11e7-9464-e4de0000002e",
        "mediaType": "application/json",
        "type": "sn",
        "id": "eb21663a-2b2b-11e7-9464-e4de0000002e",
        "idType": "native"
      },
      "name": "123",
      "code": "123",
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/73a83977-89c7-11e8-253d-a06100000004",
          "mediaType": "application/json",
          "type": "product",
          "id": "73a83977-89c7-11e8-253d-a06100000004",
          "idType": "sync"
        }
      }
    }
  ]
}

Получить Серийные номера
GET/entity/sn

Запрос на получение списка серийных номеров.

Атрибуты ответа:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

  • code - Код

  • description - Описание

  • assortment - Ссылка на товар с серийным учётом, которому принадлежит серийный номер Необходимое

Операции со сменами

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Открыть смену

PUT https://online.moysklad.ru/api/posap/1.0/rpc/openshift/
RequestsПример

Пример запроса на открытие смены.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "0001",
  "openmoment": "2016-09-06 21:41:46",
  "cheque": {
    "start": {
      "fnNumber": "1234",
      "kktRegNumber": "5678",
      "fiscalDocSign": "9012",
      "shiftNumber": "3456",
      "fiscalDocNumber": "7890",
      "time": "2016-09-06 21:41:46"
    }
  }
}
Responses204
This response has no content.

Открыть смену
PUT/rpc/openshift/

Запрос на открытие смены, привязанной к точке продаж с указанным syncId и к указанному моменту времени.

Атрибуты запроса

  • retailShift - внешний уникальный идентификатор документа (meta с syncId). Необходимое

  • name - номер смены Необходимое

  • openmoment - дата открытия смены Необходимое

  • cheque - информация о смене

    • start - информация об открытии смены
      • fnNumber - номер ФН
      • kktRegNumber - регистрационный номер ККТ
      • fiscalDocSign - фискальный признак документа
      • shiftNumber - номер смены
      • fiscalDocNumber - номер фискального документа
      • time - дата и время открытия смены

Закрыть смену

PUT https://online.moysklad.ru/api/posap/1.0/rpc/closeshift/
RequestsПример

Пример запроса на закрытие смены.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
    }
  },
  "closemoment": "2016-09-06 21:41:46",
  "retailDrawerCashout": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildrawercashout/syncid/388bd178-800c-11e6-8a84-bae5000000a4"
    }
  },
  "cheque": {
    "start": {
      "fnNumber": "1234",
      "kktRegNumber": "5678",
      "fiscalDocSign": "9012",
      "shiftNumber": "3456",
      "fiscalDocNumber": "7890",
      "time": "2016-09-06 20:41:46"
    },
    "end": {
      "fnNumber": "4321",
      "kktRegNumber": "0987",
      "fiscalDocSign": "6543",
      "shiftNumber": "2109",
      "chequesTotal": 15,
      "fiscalDocNumber": "8765",
      "fiscalDocsTotal": 17,
      "time": "2017-09-06 21:41:46"
    }
  }
}
Responses204
This response has no content.

Закрыть смену
PUT/rpc/closeshift/

Атрибуты запроса

  • retailShift - внешний уникальный идентификатор документа (meta с syncId). Указанная смена должна существовать и быть открытой Необходимое

  • closemoment - дата закрытия смены Необходимое

  • retailDrawerCashout - внешний уникальный идентификатор выплаты (meta с syncId). Если присутствует ссылка на выплату, сумма выплаты больше 0 и в настройках точки продаж стоит флаг “Создавать ПКО при закрытии смены”, то при закрытии смены будет создаваться связанный ПКО.

  • cheque - информация о смене

    • start - информация об открытии смены
      • fnNumber - номер ФН
      • kktRegNumber - регистрационный номер ККТ
      • fiscalDocSign - фискальный признак документа
      • shiftNumber - номер смены
      • fiscalDocNumber - номер фискального документа
      • time - дата и время открытия смены
    • end - информация о закрытии смены
      • fnNumber - номер ФН
      • kktRegNumber - регистрационный номер ККТ
      • fiscalDocSign - фискальный признак документа
      • shiftNumber - номер смены
      • fiscalDocNumber - номер фискального документа
      • chequesTotal - количество чеков за смену
      • fiscalDocsTotal - количество фискальных документов за смену
      • time - дата и время закрытия смены

Расчет скидок для продажи и возврата

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Расчет скидок и бонусов

POST https://online.moysklad.ru/api/posap/1.0/rpc/retaildemand/recalc
RequestsПример 1

Пример расчета для новой розничной продажи с начислением бонусов.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "1c5dcf6f-7b32-11e6-8a84-bae500000000",
      "idType": "native"
    }
  },
  "transactionType": "EARNING",
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/7db30ee8-07c5-11e7-90a5-ba9c0000008b",
          "mediaType": "application/json",
          "type": "product",
          "id": "7db30ee8-07c5-11e7-90a5-ba9c0000008b",
          "idType": "native"
        }
      },
      "sn": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/bb89b2b1-07c7-11e7-90a5-ba9c000000a5",
            "mediaType": "application/json",
            "type": "sn",
            "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a5",
            "idType": "native"
          }
        }
      ],
      "quantity": 10,
      "price": 200,
      "pack": {
        "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
        "name": "ящ",
        "quantity": 10,
        "barcode": "2000000000016"
      }
    },
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/service/bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
          "mediaType": "application/json",
          "type": "service",
          "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
          "idType": "native"
        }
      },
      "quantity": 2.33,
      "price": 300
    },
    {
      "assortment": {
        "meta": {
          "href": "http://localhost/api/posap/1.0/entity/product/ace86997-6113-11e9-ac13-000c000000c9",
          "mediaType": "application/json",
          "type": "product",
          "id": "ace86997-6113-11e9-ac13-000c000000c9",
          "idType": "native"
        }
      },
      "quantity": 1,
      "price": 200
    },
    {
      "assortment": {
        "meta": {
          "href": "http://localhost/api/posap/1.0/entity/product/c1d3dacb-6113-11e9-ac13-000c000000d2",
          "mediaType": "application/json",
          "type": "product",
          "id": "c1d3dacb-6113-11e9-ac13-000c000000d2",
          "idType": "native"
        }
      },
      "quantity": 2,
      "price": 150
    }
  ]
}
Responses200
BodyСкрытьПоказать
{
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/service/bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
          "mediaType": "application/json",
          "type": "service",
          "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a4",
          "idType": "native"
        },
        "image": {
          "href": "https://online.moysklad.ru/api/posap/1.0/download/64aab630-07c7-11e7-90a5-ba9c0000002c",
          "miniature": "https://online.moysklad.ru/api/posap/1.0/download/64aab630-07c7-11e7-90a5-ba9c0000002c?miniature=true",
          "tiny": "https://online.moysklad.ru/static/75651645-07c5-11e7-90a5-ba9c00000006/TinyImage/64aaa5a2-07c7-11e7-90a5-ba9c0000002b.png"
        },
        "name": "Имя товара1",
        "code": "код",
        "barcodes": [
          "9031101"
        ],
        "vat": 10,
        "uom": "ед. измерения",
        "article": "артикул",
        "soldByWeight": false,
        "onTap": false,
        "tobacco": false,
        "serialtrackable": false,
        "trackingType": "NOT_TRACKED"
      },
      "sn": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/bb89b2b1-07c7-11e7-90a5-ba9c000000a5",
            "mediaType": "application/json",
            "type": "sn",
            "id": "bb89b2b1-07c7-11e7-90a5-ba9c000000a5",
            "idType": "native"
          },
          "name": "Сер. номер#1"
        }
      ],
      "quantity": 10,
      "price": 100,
      "discountedPrice": 80,
      "pack": {
        "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
        "name": "ящ",
        "quantity": 10,
        "barcode": "2000000000016"
      }
    },
    {
      "assortment": {
        "meta": {
          "href": "http://localhost/api/posap/1.0/entity/product/ace86997-6113-11e9-ac13-000c000000c9",
          "mediaType": "application/json",
          "type": "product",
          "id": "ace86997-6113-11e9-ac13-000c000000c9",
          "idType": "native"
        },
        "name": "shoes",
        "code": "00002",
        "barcodes": [
          "2000000000022"
        ],
        "uom": "шт",
        "soldByWeight": false,
        "onTap": false,
        "tobacco": false,
        "trackingType": "SHOES",
        "isSerialTrackable": false,
        "partialDisposal": false
      },
      "quantity": 1,
      "price": 200,
      "discountedPrice": 200
    },
    {
      "assortment": {
        "meta": {
          "href": "http://localhost/api/posap/1.0/entity/product/c1d3dacb-6113-11e9-ac13-000c000000d2",
          "mediaType": "application/json",
          "type": "product",
          "id": "c1d3dacb-6113-11e9-ac13-000c000000d2",
          "idType": "native"
        },
        "name": "tobacco",
        "code": "00003",
        "barcodes": [
          "2000000000039"
        ],
        "uom": "шт",
        "soldByWeight": false,
        "onTap": false,
        "tobacco": true,
        "trackingType": "TOBACCO",
        "isSerialTrackable": false,
        "partialDisposal": false
      },
      "quantity": 2,
      "price": 150,
      "discountedPrice": 150
    }
  ],
  "bonusProgram": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/bonusprogram/00000000-07c7-11e7-90a5-ba9c0000002c",
      "mediaType": "application/json",
      "type": "bonusprogram",
      "id": "00000000-07c7-11e7-90a5-ba9c0000002c",
      "idType": "native"
    }
  },
  "receiptExtraInfo": "Текст\nот\nбонусов",
  "agentBonusBalance": 100,
  "bonusValueToEarn": 8,
  "bonusValueToSpend": 20,
  "chequeSumWithoutDiscount": 600,
  "valueToPay": 580,
  "paidByDiscountWithoutBonus": 0,
  "paidWithBonusPoints": 20
}

Рассчитать скидки и бонусы для продажи
POST/rpc/retaildemand/recalc

Запрос на расчет скидок и бонусов для новой розничной продажи.

Атрибуты запроса

  • agent - метаданные контрагента продажи

  • transactionType - тип операции с бонусными баллами: начисление(EARNING) или списание(SPENDING). Необходимое

  • preferredBonusToSpend - Количество бонусных баллов для списания. Целое положительное число больше 0. Если передано значение, неприменимое к данной операции, количество баллов для списания будет рассчитано, как максимально доступное для контрагента.

  • positions - позиции розничной продажи/возврата Необходимое

    • assortment - метаданные товара/модификации/услуги/комплекта Необходимое
    • quantity — количество реализуемого товара, должно быть больше нуля Необходимое
    • price - цена Необходимое
    • sn - Для товаров Массив серийных номеров. Необходимо указывать только при учёте товара по серийным номерам.
      • meta - Общее метаданные серийного номера товара Необходимое
    • pack - Упаковка
      • id - id сущности упаковки Необходимое
      • name - Название упаковки Необходимое
      • quantity - Количество товаров в упаковке Необходимое
      • barcode - Штрихкод упаковки

Атрибуты ответа:

  • bonusProgram - метаданные активной бонусной программы Необходимое

  • receiptExtraInfo - текст для вывода в чеке

  • agentBonusBalance - Баланс контрагента по активной бонусной программе ДО совершения операции Необходимое

  • bonusValueToEarn - Количество баллов которое будет начислено этой операцией Необходимое

  • bonusValueToSpend - Количество баллов которое будет списано этой операцией Необходимое

  • chequeSumWithoutDiscount - Сумма для уплаты без учета скидок Необходимое

  • paidByDiscountWithoutBonus - Сумма, оплаченная скидками, без учета бонусной программы Необходимое

  • paidWithBonusPoints - Сумма, оплаченная из бонусных баллов Необходимое

  • valueToPay - Сумма для уплаты с учетом скидок Необходимое

  • positions - позиции розничной продажи/возврата в порядке соответствующем запросу Необходимое

    • quantity — количество Необходимое
    • price - цена Необходимое
    • discountedPrice - цена после применения всех скидок Необходимое
    • assortment - даные товара/модификации/услуги/комплекта Необходимое
      • meta - Общее метаданные товара/модификации/услуги/комплекта Необходимое
      • name - Общее Наименование объекта Необходимое
      • code - Общее Код сущности
      • barcodes - Общее Массив штрихкодов сущности
      • uom - Общее Единица измерения товара (строка)
      • vat - Общее НДС
      • article - Для товаров и комплектов Артикул товара
      • soldByWeight - Для товаров Весовой товар
        • onTap - Для товаров Разливной товар
      • isSerialTrackable - Для товаров учёт по серийным номерам Необходимое
      • tobacco - Для товаров Табачная продукция. Не может быть указан вместе с egaisIsAlcoholic, soldByWeight и isSerialtrackable

      • trackingType - Тип маркируемой продукции

        • NOT_TRACKED - Без маркировки
        • TOBACCO - Тип маркировки “Табак”
        • SHOES - Тип маркировки “Обувь”
        • LP_CLOTHES - Тип маркировки “Одежда”
        • LP_LINENS - Тип маркировки “Постельное белье”
        • PERFUMERY - Тип маркировки “Духи и туалетная вода”
        • ELECTRONICS - Тип маркировки “Фотокамеры и лампы-вспышки”
        • TIRES - Тип маркировки “Шины и покрышки”
        • MILK - Тип маркировки “Молочная продукция”
        • WATER - Тип маркировки “Упакованная вода”
        • OTP - Тип маркировки “Альтернативная табачная продукция”
        • NCP - Тип маркировки “Никотиносодержащая продукция”
        • BEER_ALCOHOL - Тип маркировки “Пиво и слабоалкогольная продукция”
        • FOOD_SUPPLEMENT - Тип маркировки “Биологически активные добавки к пище”
        • SANITIZER - Тип маркировки “Антисептики”

      • tnved - Код ТН ВЭД

      • partialDisposal - Флаг частичного выбытия

      • paymentItemType - Признак предмета расчета

        • GOOD - Товар (Товар/Комплект)
        • SERVICE - Услуга (Услуга)
        • EXCISABLE_GOOD - Подакцизный товар (Товар/Комплект)
        • WORK - Работа (Услуга)
        • PROVIDING_RID - Предоставление РИД (Услуга)
        • COMPOUND_PAYMENT_ITEM - Составной предмет расчета (Товар/Комплект/Услуга)
        • ANOTHER_PAYMENT_ITEM - Иной предмет расчета (Товар/Комплект/Услуга)
      • image - Для товаров и комплектов Изображение товара (объект)
        • href - Ссылка на изображение
        • miniature - Ссылка на миниатюру изображения
        • tiny - Ссылка на уменьшенную версию изображения
      • components - Для комплектов Компоненты комплекта, это список товаров/услуг/модификаций, который входят в состав комплекта. Компонентов у комплекта может быть от 1 до 10. Необходимое
        • meta - Метаданные сущности Необходимое
        • quantity - количество компонентов в комплекте.
    • sn - Для товаров Массив серийных номеров. Необходимо указывать только при учёте товара по серийным номерам.
      • meta - метаданные серийного номера товара Необходимое
      • name - Наименование серийного номера
    • pack - Упаковка
      • id - id сущности упаковки Необходимое
      • name - Название упаковки Необходимое
      • quantity - Количество товаров в упаковке Необходимое
      • barcode - Штрихкод упаковки

Продажи

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Продажи в смене

POST https://online.moysklad.ru/api/posap/1.0/entity/retaildemand
RequestsПример 1

Пример создания новой розничной продажи.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "000219991",
  "moment": "2016-09-06 21:41:46",
  "description": "размен",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10,
      "sum": 1000,
      "pdf": [
        "abc",
        "def"
      ],
      "marks": [
        {
          "cis": "12345678900987ABCDEFGabcdefgh"
        },
        {
          "cis": "00000046185372KY4mjNZAB=U/FkO"
        }
      ]
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "sum": 800,
      "sn": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352a",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352b",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352d",
            "mediaType": "application/json"
          }
        }
      ],
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "cashSum": 800,
  "noCashSum": 100,
  "qrSum": 0,
  "vatEnabled": true,
  "vatIncluded": true,
  "bottleUrl": "https://check.egais.ru?id=a9e56cb9-21d6-4404-9f24-668020fadf6a&amp;dt=0910141104&amp;cn=Magazin2014",
  "bottleSign": "418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B",
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  },
  "customerOrder": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/7c1b81ab-5a9d-11e8-7a31-ca1400000027",
      "mediaType": "application/json",
      "type": "customerorder",
      "id": "7c1b81ab-5a9d-11e8-7a31-ca1400000027",
      "idType": "native"
    }
  },
  "bonusProgram": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/bonusprogram/7c1b81ab-5a9d-11e8-7a31-ca1400000026",
      "mediaType": "application/json",
      "type": "bonusprogram",
      "id": "7c1b81ab-5a9d-11e8-7a31-ca1400000026",
      "idType": "native"
    }
  },
  "bonusValueToEarn": 0,
  "bonusValueToSpend": 0,
  "prepaymentCash": 123,
  "prepaymentNoCash": 222,
  "prepaymentQrSum": 0
}
Responses201
This response has no content.

Создать продажу в смене
POST/entity/retaildemand

Запрос на создание новой розничной продажи в рамках смены с указанным id. Если поле agent не будет указано, для создаваемой продажи будет использован стандартный розничный покупатель.

Атрибуты запроса

  • meta - внешний уникальный идентификатор документа в формате метаданных (meta с syncId) Необходимое

  • retailShift - ссылка на смену (meta с syncId). Необходимое

  • name - Номер розничной продажи Необходимое

  • moment - Дата и время розничной продажи Необходимое

  • description - Комментарий

  • owner - Владелец (Сотрудник)

  • agent - Покупатель ссылка на контрагента в формате метаданных

  • positions - позиции розничной продажи Необходимое

    • assortment - позиция документа, ссылка на товар/модификацию/услугу/комплект в формате метаданных Необходимое
    • quantity — количество реализуемого товара, должно быть положительным Необходимое
    • price - цена Необходимое
    • discount - процент скидки
    • vat - процент НДС
    • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%
    • pdf - массив PDF-417 для алкогольных товаров
    • sn - коллекция уникальных идентификаторов серийных номеров в формате метаданных.
      Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции (quantity) должно быть равно количеству серийных номеров, переданных в значении атрибута.
    • pack - Упаковка
      • id - id сущности упаковки Необходимое
      • name - Название упаковки Необходимое
      • quantity - Количество товаров в упаковке Необходимое
      • barcode - Штрихкод упаковки
    • marks - массив кодов маркировки

  • cashSum - Оплачено наличными

  • noCashSum - Оплачено картой

  • qrSum - оплачено по QR-коду

  • vatEnabled - флаг, указывающий, что документ содержит НДС

  • vatIncluded - флаг, указывающий, включен ли НДС в цену (по умолчанию включен)

  • bottleUrl - подпись ЕГАИС

  • bottleSign - URL чека ЕГАИС

  • customerOrder - Ссылка на заказ покупателя (meta)

  • environment - информация об окружении

    • device - информация об устройстве
    • os - информация об операционной системе
    • software - информация о ПО
      • name - наименование ПО Необходимое при передаче software
      • vendor - производитель
      • version - версия ПО
    • chequePrinter - данные о ККТ
      • vendor - производитель
      • name - наименование Необходимое при передаче chequePrinter
      • serial - серийный номер
      • fiscalDataVersion - формат фискальных данных
      • driver - информация об используемом драйвере
        • name - наименование драйвера
        • version - версия драйвера
      • fiscalMemory - информация о фискальном накопителе
        • fiscalDataVersion - версия фискальной памяти
      • firmwareVersion - Версия прошивки ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)
    • scales - информация о весах
      • vendor - производитель
      • name - наименование модели весов
      • version - версия драйвера
      • firmware - версия прошивки весов

  • cheque - информация о чеке

    • fiscal - отметка о том, был ли использован ФР
    • online - признак электронного чека
    • printed - признак бумажного чека
    • phone - номер телефона, на который высылается электронный чек
    • email - адрес электронной почты, на который высылается электронный чек
    • number - номер чека
    • sum - сумма чека
    • fnNumber - номер ФН
    • fiscalDocSign - Фискальный признак документа
    • fiscalDocNumber - Номер фискального документа
    • time - время фискализации

  • cardTransaction - информация о транзакции в случае оплаты картой

    • pan - номер банковской карты
    • transactionId - id транзакции
    • authCode - inpas код аутентификации
    • rrnCode - Номер ссылки (RRN)
    • amount - сумма Необходимое
    • acquiringType - информация о типе эквайера (например: inpas/payme) Необходимое
    • approvalNumber - inpas/payme номер операции (код подтверждения)
    • description - комментарий

  • qrTransaction - информация о транзакции в случае оплаты по QR-коду

    • transactionId - id транзакции
    • externalOperationId - id заказа в системе банка
    • authCode - код авторизации транзакции
    • acquiringType - название API, через которое была проведена оплата

  • bonusProgram - Бонусная программа, ссылка в формате метаданных

  • bonusValueToEarn - Количество бонусных балов к зачислению

  • bonusValueToSpend - Количество бонусных балов к списанию

  • prepaymentCash - Предоплата нал

  • prepaymentNoCash - Предоплата безнал

  • prepaymentQrSum - предоплата по QR-коду

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Возможна привязка заказа к Розничной продаже при создании продажи. Связь передается в объекте customerOrder (meta) при создании продажи.

Если поле vatEnabled=true, а поле vatIncluded=false, то НДС не входит в цену и ее надо считать.

Возвраты

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Возвраты в смене

POST https://online.moysklad.ru/api/posap/1.0/entity/retailsalesreturn
RequestsПример 1

Пример создания нового Розничного возврата.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailsalesreturn/syncid/388bd178-800c-11e6-8a84-bae5000000a3"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "demand": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "0002199921",
  "moment": "2016-09-06 21:42:46",
  "description": "возврат размена",
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10,
      "sum": 1000,
      "pdf": [
        "abc",
        "def"
      ],
      "marks": [
        {
          "cis": "12345678900987ABCDEFGabcdefgh"
        },
        {
          "cis": "00000046185372KY4mjNZAB=U/FkO"
        }
      ]
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "sum": 800,
      "sn": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352a",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352b",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352d",
            "mediaType": "application/json"
          }
        }
      ],
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "cashSum": 800,
  "noCashSum": 100,
  "qrSum": 0,
  "vatEnabled": true,
  "vatIncluded": true,
  "bottleUrl": "https://check.egais.ru?id=a9e56cb9-21d6-4404-9f24-668020fadf6a&amp;dt=0910141104&amp;cn=Magazin2014",
  "bottleSign": "418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B",
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  }
}
Responses201
This response has no content.

Создать возврат в смене
POST/entity/retailsalesreturn

Атрибуты запроса

  • meta - внешний уникальный идентификатор документа в формате метаданных (meta с syncId) Необходимое

  • retailShift - ссылка на смену (meta с syncId). Необходимое

  • demand - Ссылка на розничную продажу в формате метаданных

  • name - Номер розничного возврата Необходимое

  • moment - Дата и время розничного возврата Необходимое

  • description - Комментарий

  • positions - позиции розничного возврата Необходимое

    • assortment - позиция документа, ссылка на товар/модификацию/услугу/комплект в формате метаданных Необходимое
    • quantity — количество реализуемого товара, должно быть положительным Необходимое
    • price - цена Необходимое
    • discount - процент скидки (поле игнорируется для возврата без основания)
    • vat - процент НДС
    • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%
    • pdf - массив PDF-417 для алкогольных товаров
    • sn - коллекция уникальных идентификаторов серийных номеров в формате метаданных.
      Значение данного атрибута игнорируется, если товар позиции не находится на серийном учете. В ином случае количество товаров в позиции (quantity) должно быть равно количеству серийных номеров, переданных в значении атрибута.
    • pack - Упаковка
      • id - id сущности упаковки Необходимое
      • name - Название упаковки Необходимое
      • quantity - Количество товаров в упаковке Необходимое
      • barcode - Штрихкод упаковки
      • marks - массив кодов маркировки

  • cashSum - Оплачено наличными

  • noCashSum - Оплачено картой

  • qrSum - оплачено по QR-коду

  • vatEnabled - флаг, указывающий, что документ содержит НДС

  • vatIncluded - флаг, указывающий, включен ли НДС в цену (по умолчанию включен)

  • bottleUrl - подпись ЕГАИС

  • bottleSign - URL чека ЕГАИС

  • environment - информация об окружении

    • device - информация об устройстве
    • os - информация об операционной системе
    • software - информация о ПО
      • name - наименование ПО Необходимое при передаче software
      • vendor - производитель
      • version - версия ПО
    • chequePrinter - данные о ККТ
      • vendor - производитель
      • name - наименование Необходимое при передаче chequePrinter
      • serial - серийный номер
      • fiscalDataVersion - формат фискальных данных
      • driver - информация об используемом драйвере
        • name - наименование драйвера
        • version - версия драйвера
      • fiscalMemory - информация о фискальном накопителе
        • fiscalDataVersion - версия фискальной памяти
      • firmwareVersion - Версия прошивки ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)
    • scales - информация о весах
      • vendor - производитель
      • name - наименование модели весов
      • version - версия драйвера
      • firmware - версия прошивки весов

  • cheque - информация о чеке

    • fiscal - отметка о том, был ли использован ФР
    • online - признак электронного чека
    • printed - признак бумажного чека
    • phone - номер телефона, на который высылается электронный чек
    • email - адрес электронной почты, на который высылается электронный чек
    • number - номер чека
    • sum - сумма чека
    • fnNumber - номер ФН
    • fiscalDocSign - Фискальный признак документа
    • fiscalDocNumber - Номер фискального документа
    • time - время фискализации

  • cardTransaction - информация о транзакции в случае оплаты картой

    • pan - номер банковской карты
    • transactionId - id транзакции
    • authCode - inpas код аутентификации
    • rrnCode - Номер ссылки (RRN)
    • amount - сумма Необходимое
    • acquiringType - информация о типе эквайера (например: inpas/payme) Необходимое
    • approvalNumber - inpas/payme номер операции (код подтверждения)
    • description - комментарий

  • qrTransaction - информация о транзакции в случае оплаты по QR-коду

    • transactionId - id транзакции
    • externalOperationId - id заказа в системе банка
    • authCode - код авторизации транзакции
    • acquiringType - название API, через которое была проведена оплата

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Если поле vatEnabled=true, а поле vatIncluded=false, то НДС не входит в цену и ее надо считать.

Внесение денег

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Внесение денег

POST https://online.moysklad.ru/api/posap/1.0/entity/retaildrawercashin/
RequestsПример 1

Пример создания нового внесения денег.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildrawercashin/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "000012",
  "moment": "2016-03-16 19:41:19",
  "sum": 7500,
  "description": "Внесение денег в денежный ящик"
}
Responses201
This response has no content.

Создать внесение денег
POST/entity/retaildrawercashin/

Запрос на создание внесения денег.

Атрибуты запроса

  • meta - внешний уникальный идентификатор документа в формате метаданных (meta с syncId) Необходимое

  • retailShift - ссылка на смену в формате метаданных. Необходимое

  • name - Номер внесения денег Необходимое

  • moment - Дата внесения денег Необходимое

  • description - Комментарий

  • sum - Сумма внесения денег Необходимое

Выплата денег

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Выплата денег

POST https://online.moysklad.ru/api/posap/1.0/entity/retaildrawercashout/
RequestsПример 1

Пример создания новой выплаты денег.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildrawercashout/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "0020012",
  "moment": "2016-04-16 19:41:19",
  "sum": 73500,
  "description": "Выплата денег из денежного ящика"
}
Responses201
This response has no content.

Создать выплату денег
POST/entity/retaildrawercashout/

Запрос на создание выплаты денег.

Атрибуты запроса

  • meta - внешний уникальный идентификатор документа в формате метаданных (meta с syncId) Необходимое

  • retailShift - ссылка на смену в формате метаданных. Необходимое

  • name - Номер выплаты денег Необходимое

  • moment - Дата выплаты денег Необходимое

  • description - Комментарий

  • sum - Сумма выплаты денег Необходимое

Предоплаты

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Предоплаты

POST https://online.moysklad.ru/api/posap/1.0/entity/prepayment
RequestsПример 1

Пример создания новой предоплаты.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/prepayment/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "name": "000219991",
  "description": "предоплата по заказу из интернет-магазин",
  "moment": "2016-09-06 21:41:46",
  "sum": 250000,
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "vatEnabled": true,
  "vatIncluded": true,
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "customerOrder": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "cashSum": 125000,
  "noCashSum": 125000,
  "qrSum": 0,
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  }
}
Responses201
This response has no content.

Создать предоплату
POST/entity/prepayment

Запрос на создание новой предоплаты по заказу в рамках смены с указанным id.

Атрибуты запроса

  • meta - внешний уникальный идентификатор документа в формате метаданных (meta с syncId) Необходимое

  • id - id сущности в сервисе

  • name - Номер предоплаты Необходимое

  • description - Комментарий

  • moment - Дата и время предоплаты

  • sum - Итоговая сумма предоплаты. Равна сумме нал + безнал.

  • agent - Покупатель ссылка на контрагента в формате метаданных

  • positions - позиции предоплаты Необходимое

    • assortment - позиция документа, ссылка на товар/модификацию/услугу/комплект в формате метаданных Необходимое
    • quantity — количество реализуемого товара, должно быть положительным Необходимое
    • price - цена Необходимое
    • discount - процент скидки
    • vat - процент НДС
    • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • vatEnabled - флаг, указывающий, что документ содержит НДС

  • vatIncluded - флаг, указывающий, включен ли НДС в цену (по умолчанию включен)

  • vatIncluded - Цена включает НДС

  • vatSum - Сумма НДС

  • retailStore - ссылка на точку продаж (meta с syncId).

  • retailShift - ссылка на смену (meta с syncId). Необходимое

  • cashier - ссылка на кассира в формате метаданных.

  • customerOrder - ссылка на заказ, по которому производится предоплата в формате метаданных. Необходимое

  • cashSum - Оплачено наличными

  • noCashSum - Оплачено картой

  • qrSum - оплачено по QR-коду

  • environment - информация об окружении

    • device - информация об устройстве
    • os - информация об операционной системе
    • software - информация о ПО
      • name - наименование ПО Необходимое при передаче software
      • vendor - производитель
      • version - версия ПО
    • chequePrinter - данные о ККТ
      • vendor - производитель
      • name - наименование Необходимое при передаче chequePrinter
      • serial - серийный номер
      • fiscalDataVersion - формат фискальных данных
      • driver - информация об используемом драйвере
        • name - наименование драйвера
        • version - версия драйвера
      • fiscalMemory - информация о фискальном накопителе
        • fiscalDataVersion - версия фискальной памяти
      • firmwareVersion - Версия прошивки ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)
    • scales - информация о весах
      • vendor - производитель
      • name - наименование модели весов
      • version - версия драйвера
      • firmware - версия прошивки весов

  • cheque - информация о чеке

    • fiscal - отметка о том, был ли использован ФР
    • online - признак электронного чека
    • printed - признак бумажного чека
    • phone - номер телефона, на который высылается электронный чек
    • email - адрес электронной почты, на который высылается электронный чек
    • number - номер чека
    • sum - сумма чека
    • fnNumber - номер ФН
    • fiscalDocSign - Фискальный признак документа
    • fiscalDocNumber - Номер фискального документа
    • time - время фискализации

  • cardTransaction - информация о транзакции в случае оплаты картой

    • pan - номер банковской карты
    • transactionId - id транзакции
    • authCode - inpas код аутентификации
    • rrnCode - Номер ссылки (RRN)
    • amount - сумма Необходимое
    • acquiringType - информация о типе эквайера (например: inpas/payme) Необходимое
    • approvalNumber - inpas/payme номер операции (код подтверждения)
    • description - комментарий

  • qrTransaction - информация о транзакции в случае оплаты по QR-коду

    • transactionId - id транзакции
    • externalOperationId - id заказа в системе банка
    • authCode - код авторизации транзакции
    • acquiringType - название API, через которое была проведена оплата

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Если поле vatEnabled=true, а поле vatIncluded=false, то НДС не входит в цену и ее надо считать.

Возвраты предоплат

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Возвраты предоплат

POST https://online.moysklad.ru/api/posap/1.0/entity/prepaymentreturn
RequestsПример 1

Пример создания нового возврата предоплаты.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/prepaymentreturn/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "name": "000219991",
  "description": "возврат предоплаты",
  "moment": "2016-09-06 21:41:46",
  "sum": 250000,
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "vatEnabled": true,
  "vatIncluded": true,
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "prepayment": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/prepayment/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "cashSum": 125000,
  "noCashSum": 125000,
  "qrSum": 0,
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  }
}
Responses201
This response has no content.

Создать возврат предоплаты
POST/entity/prepaymentreturn

Запрос на создание нового возврата предоплаты рамках смены с указанным id.

Атрибуты запроса

  • meta - внешний уникальный идентификатор документа в формате метаданных (meta с syncId) Необходимое

  • id - id сущности в сервисе

  • name - Номер возврата предоплаты Необходимое

  • description - Комментарий

  • moment - Дата и время возврата предоплаты

  • sum - Итоговая сумма возврата предоплаты. Равна сумме нал + безнал. Может быть меньше суммы предоплаты.

  • positions - позиции возврата предоплаты Необходимое

    • assortment - позиция документа, ссылка на товар/модификацию/услугу/комплект в формате метаданных Необходимое
    • quantity — количество реализуемого товара, должно быть положительным Необходимое
    • price - цена Необходимое
    • discount - процент скидки
    • vat - процент НДС
    • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • vatEnabled - флаг, указывающий, что документ содержит НДС

  • vatIncluded - флаг, указывающий, включен ли НДС в цену (по умолчанию включен)

  • vatIncluded - Цена включает НДС

  • vatSum - Сумма НДС

  • retailStore - ссылка на точку продаж (meta с syncId).

  • retailShift - ссылка на смену (meta с syncId). Необходимое

  • cashier - ссылка на кассира в формате метаданных.

  • prepayment - ссылка на предоплату, для которой производится возврат в формате метаданных. Необходимое

  • cashSum - Оплачено наличными

  • noCashSum - Оплачено картой

  • qrSum - оплачено по QR-коду

  • environment - информация об окружении

    • device - информация об устройстве
    • os - информация об операционной системе
    • software - информация о ПО
      • name - наименование ПО Необходимое при передаче software
      • vendor - производитель
      • version - версия ПО
    • chequePrinter - данные о ККТ
      • vendor - производитель
      • name - наименование Необходимое при передаче chequePrinter
      • serial - серийный номер
      • fiscalDataVersion - формат фискальных данных
      • driver - информация об используемом драйвере
        • name - наименование драйвера
        • version - версия драйвера
      • fiscalMemory - информация о фискальном накопителе
        • fiscalDataVersion - версия фискальной памяти
      • firmwareVersion - Версия прошивки ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)
    • scales - информация о весах
      • vendor - производитель
      • name - наименование модели весов
      • version - версия драйвера
      • firmware - версия прошивки весов

  • cheque - информация о чеке

    • fiscal - отметка о том, был ли использован ФР
    • online - признак электронного чека
    • printed - признак бумажного чека
    • phone - номер телефона, на который высылается электронный чек
    • email - адрес электронной почты, на который высылается электронный чек
    • number - номер чека
    • sum - сумма чека
    • fnNumber - номер ФН
    • fiscalDocSign - Фискальный признак документа
    • fiscalDocNumber - Номер фискального документа
    • time - время фискализации

  • cardTransaction - информация о транзакции в случае оплаты картой

    • pan - номер банковской карты
    • transactionId - id транзакции
    • authCode - inpas код аутентификации
    • rrnCode - Номер ссылки (RRN)
    • amount - сумма Необходимое
    • acquiringType - информация о типе эквайера (например: inpas/payme) Необходимое
    • approvalNumber - inpas/payme номер операции (код подтверждения)
    • description - комментарий

  • qrTransaction - информация о транзакции в случае оплаты по QR-коду

    • transactionId - id транзакции
    • externalOperationId - id заказа в системе банка
    • authCode - код авторизации транзакции
    • acquiringType - название API, через которое была проведена оплата

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Если поле vatEnabled=true, а поле vatIncluded=false, то НДС не входит в цену и ее надо считать.

Заказы покупателей

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Заказы покупателей

GET https://online.moysklad.ru/api/posap/1.0/entity/customerorder
Responses200

Успешный запрос. Результат - JSON представление списка Заказов покупателей.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder",
    "mediaType": "application/json",
    "size": 1,
    "limit": 100,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/0f175046-dbca-11e6-5bed-427b00000079",
        "mediaType": "application/json",
        "type": "customerorder",
        "id": "0f175046-dbca-11e6-5bed-427b00000079",
        "idType": "native"
      },
      "id": "0f175046-dbca-11e6-5bed-427b00000079",
      "name": "00001",
      "description": "2222222222222",
      "moment": "2017-01-16 11:59:00",
      "vatEnabled": true,
      "vatIncluded": true,
      "deliveryPlannedMoment": "2017-02-01 17:12:00",
      "state": {
        "name": "Новый",
        "color": 15106326,
        "type": "Regular"
      },
      "positions": [
        {
          "assortment": {
            "meta": {
              "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000003",
              "mediaType": "application/json",
              "type": "product",
              "id": "d90cda3b-1f6c-11e7-8a7f-40d000000003",
              "idType": "native"
            },
            "name": "good1",
            "code": "00034",
            "uom": "шт",
            "barcodes": [
              "2000000000367"
            ],
            "salePrices": [
              {
                "value": 6000,
                "priceType": "Цена продажи"
              },
              {
                "value": 4000,
                "priceType": "Цена распродажи"
              }
            ],
            "soldByWeight": false,
            "onTap": false,
            "isSerialTrackable": false,
            "paymentItemType": "GOOD",
            "isDiscountProhibited": false
          },
          "quantity": 1,
          "price": 0,
          "vat": 0,
          "vatEnabled": false,
          "discount": 0,
          "reserve": 0
        },
        {
          "assortment": {
            "meta": {
              "href": "http://online.moysklad.ru/api/posap/1.0/entity/variant/cca27551-5cc3-11e7-6a80-332a000000a4",
              "mediaType": "application/json",
              "type": "variant",
              "id": "cca27551-5cc3-11e7-6a80-332a000000a4",
              "idType": "native"
            },
            "name": "good1 (variant)",
            "code": "00035",
            "uom": "шт",
            "barcodes": [
              "2000000000369"
            ],
            "salePrices": [
              {
                "value": 6000,
                "priceType": "Цена продажи"
              },
              {
                "value": 5000,
                "priceType": "Цена распродажи"
              }
            ],
            "soldByWeight": false,
            "onTap": false,
            "isSerialTrackable": false,
            "paymentItemType": "ANOTHER_PAYMENT_ITEM",
            "isDiscountProhibited": false
          },
          "quantity": 10,
          "price": 0,
          "vat": 0,
          "vatEnabled": false,
          "discount": 0,
          "reserve": 0,
          "pack": {
            "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
            "name": "ящ",
            "quantity": 10,
            "barcode": "2000000000016"
          }
        },
        {
          "assortment": {
            "meta": {
              "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000103",
              "mediaType": "application/json",
              "type": "product",
              "id": "d90cda3b-1f6c-11e7-8a7f-40d000000103",
              "idType": "native"
            },
            "name": "mask",
            "code": "00134",
            "uom": "шт",
            "barcodes": [
              "2000000023367"
            ],
            "salePrices": [
              {
                "value": 3500,
                "priceType": "Цена продажи"
              }
            ],
            "soldByWeight": false,
            "onTap": false,
            "isSerialTrackable": false,
            "paymentItemType": "GOOD",
            "isDiscountProhibited": false,
            "ppeType": "2400001323807"
          },
          "quantity": 1,
          "price": 0,
          "vat": 0,
          "vatEnabled": false,
          "discount": 0,
          "reserve": 0
        }
      ],
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/90fdbe2f-d973-11e6-5bed-427b00000056",
          "mediaType": "application/json",
          "type": "counterparty",
          "id": "90fdbe2f-d973-11e6-5bed-427b00000056",
          "idType": "native"
        },
        "name": "ООО \"Покупатель\""
      },
      "prepayments": [
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
            "mediaType": "application/json",
            "type": "prepayment",
            "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
            "idType": "native"
          },
          "name": "00010"
        },
        {
          "meta": {
            "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
            "mediaType": "application/json",
            "type": "prepayment",
            "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
            "idType": "native"
          },
          "name": "00011"
        }
      ],
      "paidInCash": 123,
      "paidNoCash": 222,
      "paidByQr": 0,
      "shippedSum": 111
    }
  ]
}

Получить Заказы покупателей
GET/entity/customerorder

Запрос на получение списка Заказов покупателей, соответствующих складу и организации точки продаж. Не выгружаются Заказы с сериями, алкогольными товарами, непроведенные заказы, а также заказы без позиций и заказы, у которых более 1000 позиций.

Атрибуты ответа:

Служебные

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • id - ID в формате UUID Необходимое

Основные данные

  • name - Имя Необходимое

  • description - Описание

  • moment - Дата Необходимое

  • vatEnabled - Учитывается ли НДС Необходимое

  • vatIncluded - Включен ли НДС в цену Необходимое

  • deliveryPlannedMoment - Планируемая дата отгрузки

  • state - Статус

  • positions - Ссылка на позиции в формате метаданных Необходимое

  • agent - Ссылка на покупателя в формате метаданных (Если заказ назначен на стандартного розничный покупателя, то это поле не придёт в составе заказа)

  • paidInCash - Оплачено наличными по заказу

  • paidNoCash - Оплачено картой по заказу

  • paidByQr - Оплачено по QR-коду по заказу

  • shippedSum - Отгружено

  • prepayments - Предоплаты связанные с заказом покупателя

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/комплектов. Объект позиции Заказа содержит следующие поля:

  • assortment - Ссылка на товар/услугу/модификацию/комплект (мета), которую представляет собой позиция Необходимое

  • quantity - Количество товаров/услуг/модификаций/комплектов данного вида в позиции Необходимое

  • price - Цена товаров/услуг/модификаций/комплекта в копейках Необходимое

  • vat - НДС, которым облагается текущая позиция Необходимое

  • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • discount - Процент скидки или наценки Необходимое

  • reserve - Резерв данной позиции Необходимое

  • pack - Упаковка

    • id - id сущности упаковки Необходимое
    • name - Название упаковки Необходимое
    • quantity - Количество товаров в упаковке Необходимое
    • barcode - Штрихкод упаковки

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Статус Заказа покупателя

Объект статуса Заказа содержит следующие поля:

  • name - Наименование Необходимое

  • color - Цвет в цветовом пространстве ARGB Необходимое

  • type - Тип. Возможные значения: [Regular(обычный), Successful(Финальный положительный), Unsuccessful(Финальный отрицательный)] Необходимое

Покупатель Заказа покупателя

Объект покупателя Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Предоплаты Заказа покупателя

Объект предоплаты Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Настройки, влияющие на выдачу заказов:

У точки продаж в основном приложении есть настройка: “Выгружать только заказы со статусами”, которая влияет на выдачу заказов. Если в этой настройке указаны статусы, то, при запросе заказов, будут возвращены только заказы с указанными статусами. Если статусы не указаны, будут выгружаться заказы со всеми статусами в т.ч. пустыми.

Заказы покупателей

GET https://online.moysklad.ru/api/posap/1.0/entity/customerorder/7944ef04-f831-11e5-7a69-971500188b19
Responses200

Успешный запрос. Результат - JSON представление списка Заказов покупателей.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/0f175046-dbca-11e6-5bed-427b00000079",
    "mediaType": "application/json",
    "type": "customerorder",
    "id": "0f175046-dbca-11e6-5bed-427b00000079",
    "idType": "native"
  },
  "id": "0f175046-dbca-11e6-5bed-427b00000079",
  "name": "00001",
  "description": "2222222222222",
  "moment": "2017-01-16 11:59:00",
  "vatEnabled": true,
  "vatIncluded": true,
  "deliveryPlannedMoment": "2017-02-01 17:12:00",
  "state": {
    "name": "Новый",
    "color": 15106326,
    "type": "Regular"
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000003",
          "mediaType": "application/json",
          "type": "product",
          "id": "d90cda3b-1f6c-11e7-8a7f-40d000000003",
          "idType": "native"
        },
        "name": "good1",
        "code": "00034",
        "uom": "шт",
        "barcodes": [
          "2000000000367"
        ],
        "salePrices": [
          {
            "value": 6000,
            "priceType": "Цена продажи"
          },
          {
            "value": 4000,
            "priceType": "Цена распродажи"
          }
        ],
        "soldByWeight": false,
        "onTap": false,
        "isSerialTrackable": false,
        "paymentItemType": "GOOD",
        "isDiscountProhibited": false
      },
      "quantity": 1,
      "price": 0,
      "vat": 0,
      "vatEnabled": false,
      "discount": 0,
      "reserve": 0
    },
    {
      "assortment": {
        "meta": {
          "href": "http://online.moysklad.ru/api/posap/1.0/entity/variant/cca27551-5cc3-11e7-6a80-332a000000a4",
          "mediaType": "application/json",
          "type": "variant",
          "id": "cca27551-5cc3-11e7-6a80-332a000000a4",
          "idType": "native"
        },
        "name": "good1 (variant)",
        "code": "00035",
        "uom": "шт",
        "barcodes": [
          "2000000000369"
        ],
        "salePrices": [
          {
            "value": 6000,
            "priceType": "Цена продажи"
          },
          {
            "value": 5000,
            "priceType": "Цена распродажи"
          }
        ],
        "soldByWeight": false,
        "onTap": false,
        "isSerialTrackable": false,
        "paymentItemType": "ANOTHER_PAYMENT_ITEM",
        "isDiscountProhibited": false
      },
      "quantity": 10,
      "price": 0,
      "vat": 0,
      "vatEnabled": false,
      "discount": 0,
      "reserve": 0,
      "pack": {
        "id": "5ae9e6b5-7b95-11e9-ac12-000b000000ac",
        "name": "ящ",
        "quantity": 10,
        "barcode": "2000000000016"
      }
    },
    {
      "assortment": {
        "meta": {
          "href": "http://online.moysklad.ru/api/posap/1.0/entity/product/d90cda3b-1f6c-11e7-8a7f-40d000000103",
          "mediaType": "application/json",
          "type": "product",
          "id": "d90cda3b-1f6c-11e7-8a7f-40d000000103",
          "idType": "native"
        },
        "name": "mask",
        "code": "00134",
        "uom": "шт",
        "barcodes": [
          "2000000023367"
        ],
        "salePrices": [
          {
            "value": 3500,
            "priceType": "Цена продажи"
          }
        ],
        "soldByWeight": false,
        "onTap": false,
        "isSerialTrackable": false,
        "paymentItemType": "GOOD",
        "isDiscountProhibited": false,
        "ppeType": "2400001323807"
      },
      "quantity": 1,
      "price": 0,
      "vat": 0,
      "vatEnabled": false,
      "discount": 0,
      "reserve": 0
    }
  ],
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/90fdbe2f-d973-11e6-5bed-427b00000056",
      "mediaType": "application/json",
      "type": "counterparty",
      "id": "90fdbe2f-d973-11e6-5bed-427b00000056",
      "idType": "native"
    },
    "name": "ООО \"Покупатель\""
  },
  "prepayments": [
    {
      "meta": {
        "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
        "mediaType": "application/json",
        "type": "prepayment",
        "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e31",
        "idType": "native"
      },
      "name": "00010"
    },
    {
      "meta": {
        "href": "http://online.moysklad.ru/api/posap/1.0/entity/prepayment/6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
        "mediaType": "application/json",
        "type": "prepayment",
        "id": "6e13d2e1-b0ba-4f70-bd39-0b7dfd6c2e30",
        "idType": "native"
      },
      "name": "00011"
    }
  ],
  "paidInCash": 123,
  "paidNoCash": 222,
  "paidByQr": 0,
  "shippedSum": 111
}

Получить Заказ покупателя
GET/entity/customerorder/{id}

Запрос на получение заказа для точки продаж.

Атрибуты ответа:

Служебные

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • id - ID в формате UUID Необходимое

Основные данные

  • name - Имя Необходимое

  • description - Описание

  • moment - Дата Необходимое

  • vatEnabled - Учитывается ли НДС Необходимое

  • vatIncluded - Включен ли НДС в цену Необходимое

  • deliveryPlannedMoment - Планируемая дата отгрузки

  • state - Статус

  • positions - Ссылка на позиции в формате метаданных Необходимое

  • agent - Ссылка на покупателя в формате метаданных (Если заказ назначен на стандартного розничный покупателя, то это поле не придёт в составе заказа)

  • paidInCash - Оплачено наличными по заказу

  • paidNoCash - Оплачено картой по заказу

  • paidByQr - Оплачено по QR-коду по заказу

  • shippedSum - Отгружено

  • prepayments - Предоплаты связанные с заказом покупателя

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/комплектов. Объект позиции Заказа содержит следующие поля:

  • assortment - Ссылка на товар/услугу/модификацию/комплект (мета), которую представляет собой позиция Необходимое

  • quantity - Количество товаров/услуг/модификаций/комплектов данного вида в позиции Необходимое

  • price - Цена товаров/услуг/модификаций/комплекта в копейках Необходимое

  • vat - НДС, которым облагается текущая позиция Необходимое

  • vatEnabled - включен ли НДС для позиции. С помощью этого флага для позиции можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • discount - Процент скидки или наценки Необходимое

  • reserve - Резерв данной позиции Необходимое

  • pack - Упаковка

    • id - id сущности упаковки Необходимое
    • name - Название упаковки Необходимое
    • quantity - Количество товаров в упаковке Необходимое
    • barcode - Штрихкод упаковки

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Статус Заказа покупателя

Объект статуса Заказа содержит следующие поля:

  • name - Наименование Необходимое

  • color - Цвет в цветовом пространстве ARGB Необходимое

  • type - Тип. Возможные значения: [Regular(обычный), Successful(Финальный положительный), Unsuccessful(Финальный отрицательный)] Необходимое

Покупатель Заказа покупателя

Объект покупателя Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Предоплаты Заказа покупателя

Объект предоплаты Заказа содержит следующие поля:

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • name - Имя Необходимое

Настройки, влияющие на выдачу заказов:

У точки продаж в основном приложении есть настройка: “Выгружать только заказы со статусами”, которая влияет на выдачу заказов. Если в этой настройке указаны статусы, то, при запросе заказов, будут возвращены только заказы с указанными статусами. Если статусы не указаны, будут выгружаться заказы со всеми статусами в т.ч. пустыми.

URI Параметры
СкрытьПоказать
id
string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id Заказа покупателя

Заказы покупателей

POST https://online.moysklad.ru/api/posap/1.0/entity/customerorder
RequestsПример 1

Пример создания нового заказа покупателя.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "moment": "2018-09-06 21:41:46",
  "description": "Описание заказа",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/syncid/f085d67e-6eae-11e6-8a84-bc520403352a"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "taxSystem": "SIMPLIFIED_TAX_SYSTEM_INCOME"
}
Responses201
This response has no content.

Создать заказ покупателя
POST/entity/customerorder

Запрос на создание нового заказа покупателя.

Обязательные поля для создания заказа:

  • meta - Метаданные

  • agent - Ссылка на контрагента.

В случае, если не будет передано поле name - оно будет автоматически присвоено на сервере. После создания, заказу будет выставлена Организация, указанная в настройках точки продаж.

Атрибуты запроса

  • taxSystem - Код системы налогообложения.
Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED

Розничные операции

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Розничные операции

GET https://online.moysklad.ru/api/posap/1.0/entity/retailoperation
Responses200

Успешный запрос. Результат - JSON представление списка Заказов покупателей.

Headers
Content-Type: application/json
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailoperation",
    "mediaType": "application/json",
    "size": 2,
    "limit": 25,
    "offset": 0
  },
  "rows": [
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailsalesreturn/syncid/6f2a160d-5842-452c-9845-a8fd82b43a62",
        "mediaType": "application/json",
        "type": "retailsalesreturn",
        "id": "6f2a160d-5842-452c-9845-a8fd82b43a62",
        "idType": "sync"
      },
      "id": "9f80f80e-d49e-11e9-ac12-000b000001a4",
      "name": "00001",
      "moment": "2019-09-11 17:15:00",
      "sum": 0,
      "noCashSum": 0,
      "qrSum": 0,
      "agent": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/organization/1415fdba-d49b-11e9-ac12-000b00000068",
          "mediaType": "application/json",
          "type": "organization",
          "id": "1415fdba-d49b-11e9-ac12-000b00000068",
          "idType": "native"
        },
        "name": "123"
      },
      "retailShift": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/4676fe33-d49d-11e9-ac12-000b0000018f",
          "mediaType": "application/json",
          "type": "retailshift",
          "id": "4676fe33-d49d-11e9-ac12-000b0000018f",
          "idType": "native"
        },
        "name": "00001",
        "openmoment": "2019-09-11 17:05:00"
      },
      "prepaymentCash": 0,
      "prepaymentNoCash": 0,
      "prepaymentQrSum": 0,
      "returned": false
    },
    {
      "meta": {
        "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/21356f1a-1826-475b-bf7c-80d2ced0229f",
        "mediaType": "application/json",
        "type": "retaildemand",
        "id": "21356f1a-1826-475b-bf7c-80d2ced0229f",
        "idType": "sync"
      },
      "id": "4682ea35-d49d-11e9-ac12-000b00000191",
      "name": "00001",
      "moment": "2019-09-11 17:05:00",
      "sum": 1000,
      "noCashSum": 1000,
      "qrSum": 0,
      "retailShift": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/4676fe33-d49d-11e9-ac12-000b0000018f",
          "mediaType": "application/json",
          "type": "retailshift",
          "id": "4676fe33-d49d-11e9-ac12-000b0000018f",
          "idType": "native"
        },
        "name": "00001",
        "openmoment": "2019-09-11 17:05:00"
      },
      "prepaymentCash": 0,
      "prepaymentNoCash": 0,
      "prepaymentQrSum": 0,
      "returned": true
    }
  ]
}

Получить Розничные операции
GET/entity/retailoperation

Запрос на получение розничных операций.

Атрибуты ответа:

Служебные

  • meta - Уникальный идентификатор в формате метаданных Необходимое

  • id - ID в формате UUID Необходимое

Основные данные

  • name - Имя Необходимое

  • agent - Ссылка на покупателя в формате метаданных

  • sum - Сумма операции

  • noCashSum - Оплачено картой

  • qrSum - оплачено по QR-коду

  • moment - Дата и время розничной операции

  • retailShift - Смена с датой открытия и закрытия

  • prepaymentCash - Предоплата наличными

  • prepaymentNoCash - Предоплата картой

  • prepaymentQrSum - предоплата по QR-коду

  • returned - Признак того, был ли сделан возврат

  • masterShift - Смена на которой была фискализирована операция с датой открытия и закрытия

  • isCloud - Признак того, что операция была фискализирована удаленно

Дополнительные данные продажи в списке операций

  • prepaymentCash - Предоплата наличными

  • prepaymentNoCash - Предоплата картой

  • prepaymentQrSum - предоплата по QR-коду

Данные, получаемые из запроса конкретного заказа

  • name - Имя Необходимое

  • description - Описание

  • moment - Дата Необходимое

  • vatIncluded - Включен ли НДС в цену Необходимое

  • vatEnabled - Учитывается ли НДС Необходимое

  • deliveryPlannedMoment - Планируемая дата отгрузки

  • state - Статус

  • positions - Ссылка на позиции в формате метаданных Необходимое

  • agent - Ссылка на покупателя в формате метаданных вместе с телефоном, именем и email Необходимое

Позиции Заказа покупателя

Позиции Заказа - это список товаров/услуг/модификаций/комплектов. Объект позиции Заказа содержит следующие поля:

  • assortment - Ссылка на товар/услугу/модификацию/комплект в формате метаданных, которую представляет собой позиция Необходимое

  • quantity - Количество товаров/услуг/модификаций/комплектов данного вида в позиции Необходимое

  • price - Цена товаров/услуг/модификаций/комплекта в копейках Необходимое

  • vat - НДС, которым облагается текущая позиция Необходимое

  • discount - Процент скидки или наценки Необходимое

  • reserve - Резерв данной позиции Необходимое

  • sn - список серийных номеров

    • meta - Метаданные о серийном номере
    • name - Имя

Ассортимент позиции

Ассортимент позиции - информация о товаре в позиции заказа Объект ассортимента содержит следующие поля:

  • meta - Метаданные, представляющие собой ссылку на объект

  • name - Наименование

  • code - Код

  • article - Артикул товара

  • images - Изображения товара в формате метаданных

  • barcodes - Массив штрихкодов

  • uom - Единица измерения

  • soldByWeight - Продажа по весу (только у товара)

  • onTap - Продажа на разлив (только у товара)

  • isSerialTrackable - Учет по серийным номерам. Не может быть указан вместе с alcoholic и weighed (только у товара)

  • salePrices - Цены продажи (нет у серий)

  • egaisIsAlcoholic - отметка о том, является ли товар алкогольным (приходит только для товаров)

  • label - Имя серии (выводится только для серий)

Поля комплектов

  • components - Компоненты комплекта, это список товаров/услуг/модификаций, который входят в состав комплекта. Компонентов у комплекта может быть от 1 до 10 Необходимое
    • meta - Метаданные сущности Необходимое
    • quantity - Количество компонентов в комплекте. Выводятся в виде метаданных сущности.

Фильтры

  • search - Поиск по номеру операции (вхождение поисковой строки, как подстроки имени операции), по сумме операции (с точностью до знака после точки), по названию позиции (только одной) и по имени контрагента, если длина поискового запроса больше 2х символов. Тип значения - строка.

  • dtype - Поиск по типу операции (только по одному и в нижнем регистре). Тип значения - строка.

Создание продажи на фискализацию

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Продажа на фискализацию

POST https://online.moysklad.ru/api/posap/1.0/cheque/minion/entity/retaildemand
RequestsПример 1

Пример создания новой розничной продажи.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "000219991",
  "moment": "2016-09-06 21:41:46",
  "description": "размен",
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10,
      "sum": 1000,
      "pdf": [
        "abc",
        "def"
      ],
      "marks": [
        {
          "cis": "12345678900987ABCDEFGabcdefgh"
        },
        {
          "cis": "00000046185372KY4mjNZAB=U/FkO"
        }
      ]
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "sum": 800,
      "sn": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352a",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352b",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352d",
            "mediaType": "application/json"
          }
        }
      ],
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "cashSum": 800,
  "noCashSum": 100,
  "qrSum": 0,
  "vatEnabled": true,
  "vatIncluded": true,
  "bottleUrl": "https://check.egais.ru?id=a9e56cb9-21d6-4404-9f24-668020fadf6a&amp;dt=0910141104&amp;cn=Magazin2014",
  "bottleSign": "418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B",
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  },
  "customerOrder": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/7c1b81ab-5a9d-11e8-7a31-ca1400000027",
      "mediaType": "application/json",
      "type": "customerorder",
      "id": "7c1b81ab-5a9d-11e8-7a31-ca1400000027",
      "idType": "native"
    }
  },
  "bonusProgram": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/bonusprogram/7c1b81ab-5a9d-11e8-7a31-ca1400000026",
      "mediaType": "application/json",
      "type": "bonusprogram",
      "id": "7c1b81ab-5a9d-11e8-7a31-ca1400000026",
      "idType": "native"
    }
  },
  "bonusValueToEarn": 0,
  "bonusValueToSpend": 0,
  "prepaymentCash": 123,
  "prepaymentNoCash": 222,
  "prepaymentQrSum": 0
}
Responses201
This response has no content.

Создать продажу на фискализацию
POST/cheque/minion/entity/retaildemand

Запрос на создание продажи и помещение ее в очередь облачных чеков на фискализацию.

Атрибуты запроса

Структура полностью соответствует обычному созданию продажи для эндпоинта entity/retaildemand

Создание возврата на фискализацию

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Возврат на фискализацию

POST https://online.moysklad.ru/api/posap/1.0/cheque/minion/entity/retailsalesreturn
RequestsПример 1

Пример создания нового Розничного возврата.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailsalesreturn/syncid/388bd178-800c-11e6-8a84-bae5000000a3"
  },
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "demand": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
    }
  },
  "name": "0002199921",
  "moment": "2016-09-06 21:42:46",
  "description": "возврат размена",
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10,
      "sum": 1000,
      "pdf": [
        "abc",
        "def"
      ],
      "marks": [
        {
          "cis": "12345678900987ABCDEFGabcdefgh"
        },
        {
          "cis": "00000046185372KY4mjNZAB=U/FkO"
        }
      ]
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "sum": 800,
      "sn": [
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352a",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352b",
            "mediaType": "application/json"
          }
        },
        {
          "meta": {
            "href": "https://online.moysklad.ru/api/posap/1.0/entity/sn/f085d67e-6eae-11e6-8a84-bc520403352d",
            "mediaType": "application/json"
          }
        }
      ],
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "cashSum": 800,
  "noCashSum": 100,
  "qrSum": 0,
  "vatEnabled": true,
  "vatIncluded": true,
  "bottleUrl": "https://check.egais.ru?id=a9e56cb9-21d6-4404-9f24-668020fadf6a&amp;dt=0910141104&amp;cn=Magazin2014",
  "bottleSign": "418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B418E6A105B60250CEB20F9F9A556FA4A9575B0C07EC536DE89CA868C884E296E56BA7EC7762C9BEC285CB4D8CD90EEE9F9FC16F92CCF324829E70862F0DFEC1B",
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  }
}
Responses201
This response has no content.

Создать возврат на фискализацию
POST/cheque/minion/entity/retailsalesreturn

Запрос на создание возврата и помещение его в очередь облачных чеков на фискализацию.

Атрибуты запроса

Структура полностью соответствует обычному созданию возврата для эндпоинта entity/retailsalesreturn

Создание предоплаты на фискализацию

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Предоплата на фискализацию

POST https://online.moysklad.ru/api/posap/1.0/cheque/minion/entity/prepayment
RequestsПример 1

Пример создания новой предоплаты.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/prepayment/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "name": "000219991",
  "description": "предоплата по заказу из интернет-магазин",
  "moment": "2016-09-06 21:41:46",
  "sum": 250000,
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "vatEnabled": true,
  "vatIncluded": true,
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "customerOrder": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/customerorder/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "cashSum": 125000,
  "noCashSum": 125000,
  "qrSum": 0,
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  }
}
Responses201
This response has no content.

Создать предоплату на фискализацию
POST/cheque/minion/entity/prepayment

Запрос на создание предоплаты и помещение ее в очередь облачных чеков на фискализацию.

Атрибуты запроса

Структура полностью соответствует обычному созданию предоплаты для эндпоинта entity/prepayment

Создание возврата предоплаты на фискализацию

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Возврат предоплаты на фискализацию

POST https://online.moysklad.ru/api/posap/1.0/cheque/minion/entity/prepaymentreturn
RequestsПример 1

Пример создания нового возврата предоплаты.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/prepaymentreturn/syncid/388bd178-800c-11e6-8a84-bae5000000a2"
  },
  "name": "000219991",
  "description": "возврат предоплаты",
  "moment": "2016-09-06 21:41:46",
  "sum": 250000,
  "agent": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/688bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "positions": [
    {
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/81fdf852-7c21-11e6-8a84-bae500000068",
          "mediaType": "application/json"
        }
      },
      "quantity": 2,
      "price": 500,
      "discount": 10,
      "vat": 10
    },
    {
      "quantity": 3,
      "price": 400,
      "discount": 10,
      "vat": 10,
      "assortment": {
        "meta": {
          "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/f085d67e-6eae-11e6-8a84-bc520403352c"
        }
      }
    }
  ],
  "vatEnabled": true,
  "vatIncluded": true,
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "prepayment": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/prepayment/syncid/288bd078-800c-11e6-8a84-bae5000000a2"
    }
  },
  "cashSum": 125000,
  "noCashSum": 125000,
  "qrSum": 0,
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "environment": {
    "os": "Linux",
    "device": "Some device name",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.0"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    },
    "scales": {
      "name": "massa-k",
      "vendor": "massa-k",
      "version": "1.0",
      "firmware": "1.1"
    }
  },
  "cardTransaction": {
    "pan": "547127******8519",
    "transactionId": "5abce3f3c0ffdc014f1040de",
    "authCode": "889872",
    "rrnCode": "000010000467",
    "amount": 8600,
    "acquiringType": "Inpas",
    "approvalNumber": "055747",
    "description": "платеж картой n-Банка"
  }
}
Responses201
This response has no content.

Создать возврат предоплаты на фискализацию
POST/cheque/minion/entity/prepaymentreturn

Запрос на создание возврата предоплаты и помещение его в очередь облачных чеков на фискализацию.

Атрибуты запроса

Структура полностью соответствует обычному созданию возврата предоплаты для эндпоинта entity/prepaymentreturn

Запрос статуса фискализации операции

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Статус фискализации операции

GET https://online.moysklad.ru/api/posap/1.0/cheque/rpc/minion/status/syncid/7944ef04-f831-11e5-7a69-971500188b19
Responses200

Успешный запрос. Результат - JSON представление статуса фискализации.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "operation": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/a4a94924-ab7a-447e-b1ae-6b874242cbdd",
    "mediaType": "application/json",
    "type": "retaildemand",
    "id": "a4a94924-ab7a-447e-b1ae-6b874242cbdd",
    "idType": "sync"
  },
  "fiscalStatus": "OK",
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  }
}

Получить статус фискализации операции
GET/cheque/rpc/minion/status/syncid/{syncid}

Атрибуты ответа

  • operation - Метаданные о операции Необходимое

  • fiscalStatus - Статус фискализации Необходимое

Статус фискализации Значение поля fiscalStatus
Фискализирована OK
Ожидает фискализации PENDING
В процессе фискализации IN_PROGRESS
  • cheque - информация о чеке
    • fiscal - отметка о том, был ли использован ФР
    • online - признак электронного чека
    • printed - признак бумажного чека
    • phone - номер телефона, на который высылается электронный чек
    • email - адрес электронной почты, на который высылается электронный чек
    • number - номер чека
    • sum - сумма чека
    • fnNumber - номер ФН
    • fiscalDocSign - Фискальный признак документа
    • fiscalDocNumber - Номер фискального документа
    • time - время фискализации
URI Параметры
СкрытьПоказать
syncid
string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

syncid операции

Запрос операции на фискализацию

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Запрос операции на фискализацию

GET https://online.moysklad.ru/api/posap/1.0/cheque/rpc/master/poll/7944ef04-f831-11e5-7a69-971500188b19
Responses200
Headers
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
Content-Type: application/json
BodyСкрытьПоказать
Успешный запрос. Результат - JSON представление операции.

Получить операцию на фискализацию
GET/cheque/rpc/master/poll/{orgId}

Атрибуты ответа

Структура полностью соответствует обычному получению операции по id для эндпоинтов entity/type

URI Параметры
СкрытьПоказать
orgId
string (required) Example: 7944ef04-f831-11e5-7a69-971500188b19

id организации

Успешная фискализация

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Успешная фискализация

PUT https://online.moysklad.ru/api/posap/1.0/cheque/rpc/master/approve
Responses204

Успешный запрос. Результат - JSON представление фискализированной операции.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/a4a94924-ab7a-447e-b1ae-6b874242cbdd",
    "mediaType": "application/json",
    "type": "retaildemand",
    "id": "a4a94924-ab7a-447e-b1ae-6b874242cbdd",
    "idType": "sync"
  },
  "cheque": {
    "fiscal": true,
    "online": true,
    "printed": true,
    "phone": "89992223311",
    "email": "1@m.com",
    "number": "4165132132",
    "sum": 123.6,
    "fnNumber": "1223334444",
    "fiscalDocSign": "111222333",
    "fiscalDocNumber": "1234567",
    "time": "2016-09-06 21:41:46"
  },
  "chequePrinter": {
    "vendor": "АТОЛ",
    "name": "30Ф",
    "serial": "15636313",
    "fiscalDataVersion": "1.0",
    "driver": {
      "name": "АТОЛ (бета)",
      "version": "9.1"
    },
    "fiscalMemory": {
      "fiscalDataVersion": "1.0"
    },
    "firmwareVersion": "669"
  },
  "taxSystem": "GENERAL_TAX_SYSTEM",
  "retailShift": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/retailshift/syncid/288bd078-800c-11e6-8a84-bae5000000a2",
      "type": "retailshift",
      "id": "288bd078-800c-11e6-8a84-bae5000000a2",
      "idType": "sync"
    }
  }
}

Успешная фискализация
PUT/cheque/rpc/master/approve

Атрибуты Запроса

  • meta - Метаданные о операции Необходимое

  • cheque - информация о чеке

    • fiscal - отметка о том, был ли использован ФР
    • online - признак электронного чека
    • printed - признак бумажного чека
    • phone - номер телефона, на который высылается электронный чек
    • email - адрес электронной почты, на который высылается электронный чек
    • number - номер чека
    • sum - сумма чека
    • fnNumber - номер ФН
    • fiscalDocSign - Фискальный признак документа
    • fiscalDocNumber - Номер фискального документа
    • time - время фискализации

  • chequePrinter - данные о ККТ

    • vendor - производитель
    • name - наименование Необходимое при передаче chequePrinter
    • serial - серийный номер
    • fiscalDataVersion - формат фискальных данных
    • driver - информация об используемом драйвере
      • name - наименование драйвера
      • version - версия драйвера
    • fiscalMemory - информация о фискальном накопителе
      • fiscalDataVersion - версия фискальной памяти
    • firmwareVersion - Версия прошивки ККТ

  • taxSystem - Код системы налогообложения.

Система налогообложения Значение поля taxSystem
ОСН GENERAL_TAX_SYSTEM
УСН. Доход SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход-Расход SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
ЕСХН UNIFIED_AGRICULTURAL_TAX
ЕНВД PRESUMPTIVE_TAX_SYSTEM
Патент PATENT_BASED
  • retailShift - Метаданные о смене, в которой была фискализирована операция Необходимое

Неуспешная фискализация

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Неуспешная фискализация

PUT https://online.moysklad.ru/api/posap/1.0/cheque/rpc/master/reject
Responses204

Успешный запрос. Результат - JSON представление о ошибке фискализации.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/retaildemand/syncid/a4a94924-ab7a-447e-b1ae-6b874242cbdd",
    "mediaType": "application/json",
    "type": "retaildemand",
    "id": "a4a94924-ab7a-447e-b1ae-6b874242cbdd",
    "idType": "sync"
  },
  "fiscalErrMsg": "ФН переполнен"
}

Неуспешная фискализация
PUT/cheque/rpc/master/reject

Атрибуты Запроса

  • meta - Метаданные о операции Необходимое

  • fiscalErrMsg - информация о ошибке

Обновить статус точки продаж

Авторизация

Для данного ресурса предусмотрена авторизация по token. Все запросы к ресурсам справочника товаров и услуг должны сопровождаться HTTP заголовок Lognex-Pos-Auth-Token со значением токена, а также HTTP заголовком Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом заголовок Authorization НЕ указывается.

  • Пример:
    • Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
    • Lognex-Pos-Auth-Cashier-Uid:employee@company

О том как получить данный token можно прочитать тут.

Обновить статус точки продаж

POST https://online.moysklad.ru/api/posap/1.0/state
RequestsПример

Пример body запроса для обновления статуса точки продаж.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "environment": {
    "device": "Some device name",
    "os": "Linux",
    "software": {
      "name": "Касса МойСклад",
      "vendor": "МойСклад",
      "version": "2.2"
    },
    "chequePrinter": {
      "vendor": "АТОЛ",
      "name": "30Ф",
      "serial": "15636313",
      "fiscalDataVersion": "1.0",
      "driver": {
        "name": "АТОЛ (бета)",
        "version": "9.1"
      },
      "fiscalMemory": {
        "fiscalDataVersion": "1.1"
      },
      "firmwareVersion": "669"
    },
    "paymentTerminal": {
      "acquiringType": "payme"
    }
  },
  "state": {
    "sync": {
      "message": "Ошибка синхронизации, необходимо войти повторно",
      "lastAttemptMoment": "2016-09-06 21:41:00"
    },
    "fiscalMemory": {
      "error": {
        "code": "1003",
        "message": "Критическая ошибка"
      },
      "notSendDocCount": 25,
      "notSendFirstDocMoment": "2016-09-06 21:41:00"
    }
  }
}
Responses204
Headers
Content-Type: application/json

Обновить статус точки продаж
POST/state

Запрос на обновление статуса точки продаж.

Если поле, помеченое как Необходимое, отсутствует в запросе на обновление статуса точки продаж, то все JSON поля данного объекта (включая поля дочерних объектов), в котором находится данное поле, устанавливаются в null

Атрибуты запроса

  • environment - Информация об окружении

    • device - Информация об устройстве
    • os - Информация об операционной системе
    • software - Информация о ПО
      • name - Наименование ПО Необходимое
      • vendor - Производитель
      • version - Версия ПО
    • chequePrinter - Данные о ККТ
      • vendor - Производитель
      • name - Наименование ПО Необходимое
      • fiscalDataVersion - Формат фискальных данных
      • driver - Информация об используемом драйвере
        • name - Наименование драйвера
        • version - Версия драйвера
      • fiscalMemory - Информация о фискальном накопителе
        • fiscalDataVersion - Версия фискальной памяти
        • fiscalValidityDate - Срок действия ФН
      • firmwareVersion - Версия прошивки ККТ
      • taxSystem - Системы налогообложения, зарегистрированные в ККТ. Если в ККТ зарегистрировано несколько систем налогообложения, строка будет содержать все названия через запятую
      • frDate - Дата ККТ
    • paymentTerminal - информация о платежном терминале
      • acquiringType - информация о типе эквайера (например: inpas/payme)

  • state - Статус синхронизации

    • sync - Состояние синхронизации точки продаж
      • message - Информация о состоянии синхронизации
      • lastAttemptMoment - Дата последней синхронизации Необходимое
    • fiscalMemory - Состояние фискального накопителя
      • error - Информация об ошибке фискального накопителя
        • code - Код ошибки фискального накопителя
        • message - Описание ошибки
      • notSendDocCount - количество не отправленных в ОФД документов
      • notSendFirstDocMoment - Дата первого документа в очереди на отправку
    • paymentTerminal - информация о платежном терминале Deprecated
      • acquiringType - информация о типе эквайера (например: inpas/payme)

Создание товаров

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Создание Товара

POST https://online.moysklad.ru/api/posap/1.0/entity/product
RequestsПример

Пример body запроса для создания нового товара.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/product/syncid/388bd178-800c-11e6-8a84-bae500000099"
  },
  "name": "товар",
  "barcodes": [
    "6756173856073261598132",
    "41272104617235",
    "123"
  ],
  "price": 100.5,
  "vat": 18,
  "useParentVat": false,
  "description": "Товар, который мы создаём через posap",
  "article": "арт-10002",
  "productFolder": {
    "meta": {
      "href": "https://online.moysklad.ru/api/posap/1.0/entity/productfolder/c380a8b1-745e-11e6-007d-ff4e0000005e"
    }
  },
  "image": {
    "filename": "cat.jpg",
    "content": "/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAABkAAD/7gAmQWRvYmUAZMAAAAABAwAVBAMGCg0AACbxAABz6wAAtw4AARiwn/AHNXab18Tzkr39p3xlS3p7c5/9k="
  }
}
Responses201
This response has no content.

Создать новый товар
POST/entity/product

Запрос на создание нового товара.

Атрибуты запроса

  • meta - внешний уникальный идентификатор в формате метаданных (мета с syncId) Необходимое

  • name - Наименование Товара Необходимое

  • barcodes - Массив штрихкодов товара

  • OnTap - Поле, показывающее является ли товар разливным.

  • price - Цена продажи

  • vat - НДС %

  • vatEnabled - Включен ли НДС для товара. С помощью этого флага для товара можно выставлять НДС = 0 или НДС = “без НДС”. (vat = 0, vatEnabled = false) -> vat = “без НДС”, (vat = 0, vatEnabled = true) -> vat = 0%

  • useParentVat - использовать НДС родительской группы

  • description - Описание Товара

  • article - Артикул

  • productFolder - Ссылка на группу Товаров

  • image - Изображение Товара

    • filename - название файла с изображением Необходимое
    • content - изображение, закодированное в BASE64 Необходимое

Создание контрагентов

Авторизация (token)

Для данного ресурса необходима авторизация по token. О том как получить данный token можно прочитать тут. Варианты аутентификации с помощью token:

  • С помощью заголовков (Header): Lognex-Pos-Auth-Token со значением токена, а также Header’ом Lognex-Pos-Auth-Cashier-Uid, значением которого будет uid кассира, от имени которого выполняется запрос. При этом Header Authorization НЕ указывается.

    • Пример:
    - `Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b`
- `Lognex-Pos-Auth-Cashier-Uid:employee@company`

  • C помощью обычной BASIC авторизации с парой логин-пароль, где:

    • логин - uid кассира, от имени которого выполняется запрос
    • пароль - token точки продаж
      • Пример:
        • Username: admin@myorg
        • Password: 9aa01067f9abc091ec6354fa73b5e05fda9e07fa

  • С помощью cookie:

    • имя куки: Lognex-Pos-Auth
    • значение: <uid кассира>:<token точки продаж>
      • Пример:
        • name = Lognex-Pos-Auth
        • value = admin@myorg:4f2dc4d646bf0275de20b8f7f0b4f6fdda79cec0

Создание контрагента

POST https://online.moysklad.ru/api/posap/1.0/entity/counterparty
RequestsПример

Пример body запроса для создания нового контрагента.

Headers
Content-Type: application/json
Lognex-Pos-Auth-Token: 6ab89be1ae6ff147755625ee8da948e42612233b
Lognex-Pos-Auth-Cashier-Uid: employee@company
BodyСкрытьПоказать
{
  "meta": {
    "href": "https://online.moysklad.ru/api/posap/1.0/entity/counterparty/syncid/276a6f50-7ffd-11e6-8a84-bae50000005"
  },
  "name": "Иван Иванович",
  "discountCardNumber": "101",
  "phone": "+7 925 8762323",
  "email": "email@example.com",
  "descrption": "мой комментарий",
  "sex": "MALE",
  "birthDate": "2023-07-14 00:00:00",
  "legalFirstName": "Иван",
  "legalMiddleName": "Иванович",
  "legalLastName": "Иванов"
}
Responses201
This response has no content.

Создать Покупателя
POST/entity/counterparty

Запрос на создание нового контрагента.

Атрибуты запроса:

  • meta -внешний уникальный идентификатор в формате метаданных (мета с syncId) Необходимое

  • name - Имя Контрагента Необходимое

  • discountCardNumber - Номер дисконтной карты

  • phone - Номер городского телефона

  • email - Адрес электронной почты

  • description - Комментарий

  • legalFirstName - Имя контрагента

  • legalMiddleName - Отчество контрагента

  • legalLastName - Фамилия контрагента

  • sex - Пол контрагента [Мужской, Женский].

Пол контрагента Значение поля sex
Мужской MALE
Женский FEMALE
  • birthDate - Дата рождения контрагента

Generated by aglio on 24 Apr 2024