Изменения

← Предыдущая правка

API

10 635 байт добавлено, 8 май

м

→‎Коды и описание ошибок

|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]

|[[InSales|Инструкция по настройке]]

|-

|[[Файл:iiko.jpg|center|x80px]]

|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]

|[[Iiko|Инструкция по настройке]]

|-

|[[Файл:Leadvertex.png|center|x44px]]

|Поддерживает версии 4.10 и выше.<br>[[CS-Cart|Инструкция]]

|-

|~~style="height:100px; text-align~~[[Файл: webhooks.jpg|center;"|~~'''Webhook'''~~x100px]]

|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]

|Передача информации о статусах и заказах в вашу систему

<items>

<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>

<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>

* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.

Шифр и штрих-код заполняются исходя из начальных значений:

# Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)

# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется

# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется

# Если оба непустые - валидируется ШК, шифр не проверяется

Корректный (валидный) ШК отвечает следующим требованиям:

* длина не меньше 5 символов

* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>

* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы)

Если ШК не прошел проверку, то:

* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)

* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)

</spoiler>

В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>

* '''department''' — Подразделение, в котором оформляется заказ.

* '''costcode''' — Кост-код сотрудника.

* '''respstore''' — Код ответственного филиала.Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"

* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара

* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.

* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.

* '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты:

:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.

:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.

:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров , например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки::: 1 — Честный знак. По-умолчанию.:: 2 — ГИИС ДМДК.:: 3 — Серийный номер. :* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД. :: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки :: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа) :: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа) :: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа) :: Тэг 1212 - Признак предмета расчета :: Пример: <source lang="json">"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},"tag1212": "1"</source>

* '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты:

|-

|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города

|-

|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения

|-

|136||Specify warehouse goods in the order.||Укажите вложения в заказе

|-

|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад

|-

|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места

|-

|139||Wrong type of XML query||Ошибка запроса

|-

|140||Duplicate item code in the order.||Дублирование кода вложения в заказе

|-

|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе

|-

|}

=== Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===

Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]

== Запрос статуса заказов ==

* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.

* '''ordercode''' — Внутренний код заказа. Необязательный элемент.

* '''orderno2''' — Номер заказа из срочных. Необязательный элемент.* '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа

* '''datefrom''' — Дата заказа «с». Необязательный элемент.

* '''dateto''' — Дата заказа «по». Необязательный элемент.

<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>

<address>Петровка 38 офис 35</address>

<area>Район 1</area>

<pvz>

<paytypecode="1">CASH</paytype>

:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.

:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:

:: CASH - Наличными при получении (по-умолчанию)

:: CARD - Картой при получении

:: NO - Без оплаты.

:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)

* Атрибуты контейнера '''paytype''':

** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.

* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.

:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* '''''area''''' в контейнере '''receiver''' — район/метро получателя.

* '''''coords''''' в контейнере '''receiver''' — координаты получателя.

* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.

== Трекинг заказа по номеру ==

Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом ]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!

'''Пример запроса:'''

== Изменение заказа ==

Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''~~Параметры~~Настройки''' > '''~~Расширенные~~Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»

== Отмена заказа ==

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

Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». ~~Чтобы разрешить отмену~~ Разрешения для отмены заказов, и статусы в ~~личном кабинете курьерской службы перейдите~~ которых заказы можно отменять описаны в разделе '''~~Параметры''' > '''Расширенные''' и установите флажок '''Разрешить отмену и изменение~~ Изменение заказов'''.

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

<message>Клиент отказался от покупки</message>

<items>

* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.

* '''storeprice''' — Агентское вознаграждение.

* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты:

:* '''''code''''' — Код вложения.

:* '''''quantity''''' — Количество доставленных единиц вложения.

:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.

:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.

* '''image''' — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Контейнер '''order''' может содержать более одного контейнера '''image'''. Атрибут:

:* '''''filename''''' — Имя файла.

</orders>

</waybill>

</source>

:* 3 — Наклейки на страницу формата А4

:* 4 — Акты приема-передачи

* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

При записи в файл необходимо использовать двоичный формат записи!

<city>Краснодарский край</city>

<namecontains>новгород</namecontains>

<namecontainsparts>молоково моск</namecontainsparts>

<name>Москва</name>

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».

:* '''city''' — Поиск по всем населенным пунктам региона.

:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.

:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.

:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.

<city>Свердловская область</city>

<town regioncode="66" country="RU">Нижний Тагил</town>

<address>Щёлковское шоссе</address>

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.

Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.

* '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу

* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу

* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]

* '''acceptcash''' — Фильтр по приему наличных YES/NO

</mcheck>

</source>

== Размещение страниц на своем сайте (iframe) ==

В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте.

Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''.

[https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора:

Здесь должен отобразиться калькулятор

</iframe>

</source>

Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''':

Здесь должен отобразиться калькулятор

</iframe>

</source>

Обратите внимание! Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отоборажается.

Поддерживаемые языки и их коды:

:'''1''' — русский

:'''2''' — английский

:'''4''' — узбекский

Radmir

Бюрократы, Администраторы

792

правки

Изменения

API

Навигация

Персональные инструменты

Пространства имён

Варианты

Просмотры

Ещё

Поиск

Навигация

Инструменты