Ошибка 1007 мой склад

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

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

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

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

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

Для 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 статусы ошибок и их значения:

Также, вместе с телом ответа ошибки, вам могут прийти следующие заголовки (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

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

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

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

3000

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

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

3001

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

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

3002

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

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

3003

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

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

3004

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

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

3005

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

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

3006

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

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

3007

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

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

3008

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

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

3011

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

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

3030

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

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

Точки продаж

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.

В 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 состоит из нескольких шагов:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Точка продаж ¶

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

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

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

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

Для данного ресурса необходима авторизация по 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

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

Для данного ресурса необходима авторизация по 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

Скидки ¶

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

Для данного ресурса необходима авторизация по 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

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

Для данного ресурса необходима авторизация по 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

Папки ¶

Для данного ресурса необходима авторизация по 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