Что такое код hw_api_reason >type

XXXIX. Функции Hyperwave API

Hyperwave был разработан IICM в Graz. Он начинался как Hyper-G и сменил название на Hyperwave при коммерциализации (насколько помню, это было в 1996).

Hyperwave это не бесплатная программа. Текущая версия, 5.5, доступна на www.hyperwave.com. Можно запросить оценочную версию с ограниченным временем использования (30 дней).

Hyperwave это информационная система, аналогичная database (HIS, Hyperwave Information Server). Она сфокусирована на хранении и обслуживании документов. Документом может быть любой блок данных, которые могут сохраняться в файле. Каждый документ сопровождается записью объекта. Запись объекта/object record содержит метаданные документа. Метаданные это список атрибутов, который может быть расширен пользователем. Некоторые атрибуты всегда устанавливаются Hyperwave-сервером, другие могут модифицироваться пользователем.

С 2001 г. доступен Hyperwave SDK. Он поддерживает Java, JavaScript и C++. Данное расширение PHP базируется на интерфейсе C++. Чтобы активировать поддержку hwapi в PHP, вы должны сначала установить Hyperwave SDK и сконфигурировать PHP с опцией —with-hwapi= .

API, предоставляемый расширением HW_API, является полностью объектно-ориентированным. Он очень похож на интерфейс C++ Hyperwave SDK. Он состоит из следующих классов.

Некоторые базовые классы вроде HW_API_String , HW_API_String_Array , etc., которые имеются в Hyperwave SDK, не реализованы, поскольку PHP имеет для них полноценную замену.

Каждый класс имеет метод, имя которого идентично имени его двойника из Hyperwave SDK. Передача аргументов такой функции отличается от всех других расширений PHP и напоминает C++ API пакета HW SDK. Вместо передачи различных параметров, они все помещаются в ассоциативный массив и передаются как один параметр. Имена ключей идентичны именам, задокументированным в HW SDK. Общие параметры перечислены ниже. Если необходимы другие параметры, они будут документированы, если это необходимо.

objectIdentifier — имя или id объекта, например, «rootcollection», «0x873A8768 0x00000002».

parentIdentifier — имя или id объекта, который считается родительским.

object — экземпляр класса HW_API_Object.

parameters — экземпляр класса HW_API_Object.

version — версия объекта.

mode — целочисленное значение — способ выполнения операции.

attributeSelector — массив строк, каждая из которых содержит имя атрибута. Это используется, если вы запрашиваете запись объекта и хотите включить некоторые атрибуты.

objectQuery — запрос на выбор определённого объекта из списка объектов. Используется для уменьшения количества объектов, выдаваемых функциями вроде hw_api->children() или hw_api->find() .

Интеграция с Apache и, возможно, другими серверами уже описана в модуле Hyperwave Modul, который был первым расширением для соединения с Hyperwave Server.

Hyperwave API Функции

Integration with Apache

The integration with Apache and possible other servers is already described in the Hyperwave module which has been the first extension to connect a Hyperwave Server.

> The API prov > HW_API

HW_API_Object

HW_API_Attribute

HW_API_Error

HW_API_Content

HW_API_Reason

Some basic >HW_API_String, HW_API_String_Array, etc., which exist in the Hyperwave SDK have not been implemented since PHP has powerful replacements for them.

Each > objectIdentifier The name or id of an object, e.g. «rootcollection», «0x873A8768 0x00000002».

Methods returning boolean can return TRUE , FALSE or HW_API_Error object.

XXXIX. Функции Hyperwave API

Hyperwave был разработан IICM в Graz. Он начинался как Hyper-G и сменил название на Hyperwave при коммерциализации (насколько помню, это было в 1996).

Hyperwave это не бесплатная программа. Текущая версия, 5.5, доступна на www.hyperwave.com. Можно запросить оценочную версию с ограниченным временем использования (30 дней).

Hyperwave это информационная система, аналогичная database (HIS, Hyperwave Information Server). Она сфокусирована на хранении и обслуживании документов. Документом может быть любой блок данных, которые могут сохраняться в файле. Каждый документ сопровождается записью объекта. Запись объекта/object record содержит метаданные документа. Метаданные это список атрибутов, который может быть расширен пользователем. Некоторые атрибуты всегда устанавливаются Hyperwave-сервером, другие могут модифицироваться пользователем.

С 2001 г. доступен Hyperwave SDK. Он поддерживает Java, JavaScript и C++. Данное расширение PHP базируется на интерфейсе C++. Чтобы активировать поддержку hwapi в PHP, вы должны сначала установить Hyperwave SDK и сконфигурировать PHP с опцией —with-hwapi= .

API, предоставляемый расширением HW_API, является полностью объектно-ориентированным. Он очень похож на интерфейс C++ Hyperwave SDK. Он состоит из следующих классов.

Некоторые базовые классы вроде HW_API_String , HW_API_String_Array , etc., которые имеются в Hyperwave SDK, не реализованы, поскольку PHP имеет для них полноценную замену.

Каждый класс имеет метод, имя которого идентично имени его двойника из Hyperwave SDK. Передача аргументов такой функции отличается от всех других расширений PHP и напоминает C++ API пакета HW SDK. Вместо передачи различных параметров, они все помещаются в ассоциативный массив и передаются как один параметр. Имена ключей идентичны именам, задокументированным в HW SDK. Общие параметры перечислены ниже. Если необходимы другие параметры, они будут документированы, если это необходимо.

objectIdentifier — имя или id объекта, например, «rootcollection», «0x873A8768 0x00000002».

parentIdentifier — имя или id объекта, который считается родительским.

object — экземпляр класса HW_API_Object.

parameters — экземпляр класса HW_API_Object.

version — версия объекта.

mode — целочисленное значение — способ выполнения операции.

attributeSelector — массив строк, каждая из которых содержит имя атрибута. Это используется, если вы запрашиваете запись объекта и хотите включить некоторые атрибуты.

objectQuery — запрос на выбор определённого объекта из списка объектов. Используется для уменьшения количества объектов, выдаваемых функциями вроде hw_api->children() или hw_api->find() .

Интеграция с Apache и, возможно, другими серверами уже описана в модуле Hyperwave Modul, который был первым расширением для соединения с Hyperwave Server.

Что такое API

Приветствую!
В этой статье мы с вами рассмотрим, что такое API, где, как и для чего оно применяется. Так же мы рассмотрим, как API можно применить в своих web разработках и чем это может упростить жизнь web программисту.

Итак, начнём с определения. API (Application Programming Interface) — это интерфейс программирования, интерфейс создания приложений. Если говорить более понятным языком, то API — это готовый код для упрощения жизни программисту. API создавался для того, чтобы программист реально мог облегчить задачу написания того или иного приложения благодаря использованию готового кода (например, функций). Всем известный jQuery, написанный на JavaScript является тоже своего рода API. Если рассматривать конкретно данный пример, то jQuery позволяет намного облегчить написание кода. То что обычными средствами JavaScript можно было сделать за 30 строк, через jQuery пишется через 5-6. Если рассматривать API в общем, то можно найти очень много сервисов, представляющих решения для разработки. Самый известный на сегодняшний день — это сервис code.google.com, предоставляющий около полусотни разнообразных API! Это и интерфейс для создания Android-приложений, и различные API для работы с AJAX, и различные API приложений, которые можно легко подстроить под свой лад.

Ведь есть ли смысл писать код своими руками? Зачем трудиться над тем, что уже создано? Разве есть смысл отказываться от бесплатных решений (а фактически, и от бесплатной помощи) в web разработке? Если вы ответили на все эти вопросы «НЕТ», то считайте, что вы поняли суть API.

Но ещё хочу оговориться. Начинающим разработчикам НЕ следует пользоваться полуготовыми решениями, так как в будущем они не справятся с реальной задачей. Поэтому, если вы начинающий web программист, то не используйте полуфабрикаты! Учитесь думать своей головой, строить различные алгоритмы, чтобы понять суть программирования. Так же говорю, уже обращаясь ко всем, что API — это не готовые решения, это среда, интерфейс для создания своих проектов. Вы же не едите замороженный котлеты из магазина? Вы сначала их пожарите, не так ли? Эта аналогия очень ясно отображает суть API.

В общем, я рассказал, что такое API, где и как оно используется, самое главное, для чего. Желаю приятного изучения web программирования и постижения всё больших его глубин!

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

Что такое код hw_api_reason >type

ВНИМАНИЕ! Изменения для 54-ФЗ!

Для передачи ставки НДС при оформлении заказа добавлен атрибут items -> item -> VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС!

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

English version is HERE!

В системе «Курьерская служба 2008» имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с курьерскими службами, работающими под управлением системы MeaSoft «Курьерская служба 2008». Если Вы являетесь агрегатором, передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь подрядчиком — Вы можете забирать заказы, используя значение client=AGENT в запросе statusreq, и передавать статусы заказов используя метод setorderinfo. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

При написании данной документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если Вы не являетесь программистом — Вам необходимо привлечь к проекту профессионального программиста.

Если у Вас, после прочтения данной документации остались вопросы, Вы можете их задать по почте support@courierexe.ru. Обязательно представьтесь, напишите Ваши контактные данные (телефон, скайп) и название компании, с которой Вы хотите интегрироваться.

Содержание

Готовые интеграции

Для интеграции с популярными CMS можно скачать модули интеграции

Для отображения списка пунктов выдачи есть готовый JavaScript модуль: https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри.

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

Тестовый аккаунт

Для отладки Вы можете зайти в тестовый личный кабинет по адресу https://home.courierexe.ru/8, логин: test пароль: testm. Там на закладке «Автоматизация» Вы сможете увидеть свои запросы «глазами» нашей системы. Так же там есть интерфейс для выполнения запросов. На закладке «Отслеживание» Вы увидите созданные заказы.

Для упрощения интеграции можно скачать пример обращения к сервису на PHP.

Рабочий аккаунт для подключения

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

1. Параметр extra (Цифровой код, уникальный идентификатор компании. Запросите этот параметр у компании, с которой Вы интегрируетесь). Посмотреть этот код можно в интерфейсе программы КС2008 через основное меню «Справочники — Дополнительные возможности». Цифровое значение будет указано во второй гиперссылке (на скриншоте ниже отмечено «звездочкой»):

2. Логин — параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке «Прочее» в поле «Имя пользователя». Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. Пароль — параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке «Прочее» в поле «Пароль» (на скриншоте ниже).

Общие понятия

Для использования интеграции в «боевом» режиме, запросите логин, пароль, и параметр extra у той компании, с которой интегрируетесь. Вы можете отправлять тестовые запросы к нашему сервису в личном кабинете на закладке «Автоматизация». В личном кабинете так же можно видеть историю отправленных Вами запросов.

Клиент отправляет запросы к сервису, методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML. Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM. В силу особенностей языка XML, некоторые символы в тексте должны быть заменены: & на & на > » на «

Наше API принципиально работает только по HTTPS, т.к. передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить прокси на PHP. Как запустить

Для теста можете запустить его на сервере следующей командой: php -S :8080 proxy.php где — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы. Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес :8080

Ограничения

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

Для проверки статусов заказов лучше всего использовать запросы «statusreq» с параметром changes=ONLY_LAST. Не нужно пытаться «бомбить» наше API запросами с номерами всех ваших заказов, особенно — запросами «tracking», они предназначены не для этого (смотрите описание).

Оформление заказа

Пример оформления заказа

Описание элементов для оформления заказа

• neworder — Корневой контейнер, обязательный элемент.

• newfolder — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

• order — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере neworder может быть много контейнеров order для создания нескольких заказов одним запросом.

• orderno — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет наличие заказов с указанным номером в пределах текущего календарного года, и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists». Если не указан штрих-код (поле barcode), и значение поля подходит для использования его в качестве штрих-кода, данное значение будет скопировано в поле «Штрих-код». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).

• barcode — Штрих-код заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-код. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрих-кода, переменных для разных мест в рамках одного заказа.

Например: В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрих-кода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми, и будут отражать штрих-коды к одному заказу). Если вы не сами печатаете накладные с указанным штрих-кодом, то указанный штрих-код не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.

• sender — Информация о отправителе заказа. Необязательный контейнер.

• receiver — Информация о получателе заказа. Обязательный контейнер.

• company — Компания-получатель.
• person — Контактное лицо. Должно быть заполнено хотя бы одно из полей — company или person!
• phone — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
• town — Город.

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

Также, поиск города осуществляется с учетом почтового индекса, указанного в теге zipcode.

Поле Город контейнеров sender и receiver можно указать одним из следующих способов:

• код населенного пункта из справочника городов
• 13-ти значный код адресного классификатора КЛАДР
• 36-ти значный код адресной системы ФИАС

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

• CASH — Наличными при получении (по-умолчанию)
• CARD — Картой при получении
• NO — Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа — можно это сделать в поле , указав объявленную ценность)
• OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
• OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.

• zipcode — Почтовый индекс.
• weight — Общий вес заказа в килограммах.
• return_weight — Общий вес возврата заказа в килограммах.
• quantity — Количество мест.
• service — Режим доставки (тип услуги) передается код из справочника «Виды срочности».
• return_service — Режим возврата (тип услуги) передается код из справочника «Виды срочности».
• type — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
• return_type — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
• price — Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
• deliveryprice — Сумма доставки. В случае наличия контейнера items, в него будет добавлено вложение «Доставка».
• return — Признак необходимости возврата.
• return_service — Режим возврата (тип услуги) передается код из справочника «Виды срочности».
• enclosure — Вложение.
• inshprice — Объявленная ценность.
• instruction — Поручение — Примечание.
• receiverpays — Признак оплаты стоимости доставки получателем YES/NO. Если стоит YES, то курьер увидит, что с получателя нужно также взять стоимость доставки.
• department — Подразделение, в котором оформляется заказ.
• pickup — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
• acceptpartially — Признак возможности частичного выкупа товаров отправления YES/NO.

• items — Контейнер для описания вложений. Необязательный контейнер. Атрибуты:

• item — Название вложения.
• quantity — Количество единиц товара.
• mass — Масса единицы товара в килограммах.
• volume — Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
• length — Длина единицы товара.
• w >

  В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т.д.) — их нужно указать в том же контейнере items как товары, без артикула.

  Примеры ответов

  Пример успешного ответа

  Пример ответа с ошибкой

  Пример ответа при ошибке авторизации

  Пример ответа при ошибке синтаксиса

  Коды ошибок при оформлении заказа

  1 — Ошибка авторизации. (отсутствуют теги , неверный логин или пароль).

  2 — Отправлен пустой запрос (отсутствует контейнер в XML документе).

  3 — Некорректно указана сумма заказа.

  4 — Некорректный общий вес заказа.

  5 — Не найден город получатель.

  6 — Не найден город отправитель.

  7 — Не заполнен адрес получателя.

  8 — Не заполнен телефон получателя.

  9 — Не заполнено контактное имя получателя.

  10 — Не заполнено название компании получателя.

  11 — Некорректная сумма объявленной ценности.

  12 — Артикул не найден.

  13 — Не заполнено название компании отправителя.

  14 — Не заполнено контактное имя отправителя.

  15 — Не заполнен телефон отправителя.

  16 — Не заполнен адрес отправителя.

  17 — Заказ с таким номером уже существует.

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

  Пример запроса статуса заказа

  Описание полей запроса статуса

  statusreq — Корневой контейнер. Обязательный элемент.

  • auth — Авторизация. Обязательный элемент.
  • client — Признак клиента или агента. Необязательный элемент.
  • CLIENT — Признак клиента, значение по умолчанию
  • AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
  • orderno — Номер заказа. Необязательный элемент.
  • ordercode — Внутренний код заказа. Необязательный элемент.
  • orderno2 — Номер заказа из срочных. Необязательный элемент.
  • datefrom — Дата «с». Обязательный элемент.
  • dateto — Дата «по». Обязательный элемент.
  • target — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.
  • done — Может принимать значения:
  • ONLY_NOT_DONE — Только не доставленные
  • ONLY_DONE — Только доставленные
  • ONLY_NEW — Только новые
  • ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т.д.
  • Пусто — все корреспонденции
  • changes — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: Передача только изменившихся статусов
  • quickstatus — Указывает «глубину» передаваемых статусов: «YES» (по-умолчанию) — передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.
  1. Периода запроса статусов (контейнеры datefrom и dateto) ограничивается двумя месяцами — два месяца до даты «по».
  2. Если не указаны обе даты — dateto принимается равной текущей дате.
  3. Если не указана дата dateto — она принимается равной datefrom плюс 2 месяца.
  4. Если не указана дата datefrom — она принимается равной dateto минус 2 месяца.

  Примеры ответов

  Пример успешного ответа

  Пример ответа если нет заказов

  Пример ответа при ошибке авторизации

  Пример ответа при ошибке синтаксиса

  Описание полей ответа статусов

  Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

  • Атрибуты контейнера order:
  • awb — Номер накладной в системе курьерской службы.
  • orderno2 — Номер накладной в подсистеме срочной доставки курьерской службы.
  • ordercode — внутренний код заказа в системе, применяется для некоторых внутренних операций.
  • givencode — внутренний код заказа в системе, применяется для некоторых внутренних операций.
  • атрибут code контейнера item — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
  • returns — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.
  • coords в контейнере receiver — координаты получателя.
  • currcoords — текущие координаты заказа. Атрибуты:
  • lat — широта
  • lon — долгота
  • accuracy — точность в метрах
  • RequestDateTime — дата/время последнего обновления координат.
  • waittime — Время ожидания курьера.
  • deliveryprice — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:
  • total — общая стоимость услуг
  • delivery — стоимость доставки
  • return — стоимость возврата

  Тэг deliveryprice включает список дополнительных услуг (только для тарифа «Премиум»):

  • advprice — наименование дополнительной услуги
  • code — код дополнительной услуги
  • price — стоимость дополнительной услуги
  • status — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
  • eventstore — филиал, к которому относится текущий статус
  • eventtime — время события по часовому поясу места его наступления.
  • createtimegmt — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. Подробнее

  Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.

  • message — наименование филиала-получателя, при передаче между филиалами
  • title — русское наименование статуса
  • statushistory — история статусов доставки. Содержит список контейнеров status. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.
  • customstatecode — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
  • clientstatecode — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
  • deliveredto — данные о вручении, либо причина недоставки.
  • delivereddate — дата вручения.
  • deliveredtime — время вручения. В случае недоставки может быть пустым.
  • outstrbarcode — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.

  Значения контейнеров status могут принимать следующие значения:

  AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в бэкофисе NEW — Новый PICKUP — Забран у отправителя ACCEPTED — Получен складом INVENTORY — Инвентаризация DEPARTURING — Планируется отправка DEPARTURE — Отправлено со склада DELIVERY — Выдан курьеру на доставку COURIERDELIVERED — Доставлен (предварительно) COMPLETE — Доставлен PARTIALLY — Доставлен частично COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка. CANCELED — Не доставлен (Возврат/Отмена) RETURNING — Планируется возврат RETURNED — Возвращен WMSASSEMBLED — Скомплектован на складе WMSDISASSEMBLED — Разукомплектован CONFIRM — Согласована доставка DATECHANGE — Перенос NEWPICKUP — Создан забор UNCONFIRM — Не удалось согласовать доставку PICKUPREADY — Готов к выдаче LOST — Утрачен/утерян COURIERPARTIALLY — Частично со слов курьера COURIERCANCELED — Отказ со слов курьера

  Примечание: В будущем возможно расширение и изменение используемого набора статусов.

  1. Атрибуты контейнера status заполняются для версий системы 2008.0.0.670 и новее.
  2. Контейнер statushistory заполняется для тарифа «Премиум» и версий системы 2008.0.0.670 и новее.
  3. Контейнер deliveryprice заполняется для тарифа «Премиум».

  Передача только изменившихся статусов

  В нашем API предусмотрено очень удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз в какое-то время, например, в 10 минут, вы посылаете запрос «А покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены, и их не надо передавать повторно. Т.о. сколько бы заказов у вас не было, статусы по ним всем почти в реальном времени вы можете получать всего 2-мя запросами.

  Для получения только изменившихся статусов отправьте запрос

  Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:

  После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос

  Описание полей запроса

  • auth — Авторизация. Обязательный элемент.
  • client — Признак клиента или агента. Необязательный элемент.
  • CLIENT — Признак клиента, значение по умолчанию
  • AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

  В случае успеха Вы получите ответ

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

  1. При данном способе передачи ( ONLY_LAST ) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее — изменение статуса по нему не попадет в результат выполнения данного запроса.
  2. Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». В промежутке между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться в следствии ограничений версии или тарифа конкретной службы доставки).
  3. Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.

  Получение вложений к накладной

  attachments — Корневой контейнер. Обязательный элемент.

  • auth — Авторизация. Обязательный элемент.
  • orderno — Номер/код заказа. Обязательный элемент.

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

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

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

  Получение информации в формате 17 TRACK

  Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.
  Описание контейнеров ответа аналогично описанию Запроса статусов заказов.

  Изменение статуса агентом

  Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».

  Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле Инфо о доставке.

  При необходимости к заказу можно прикрепить изображения.

  Пример запроса изменения статуса:

  Описание полей запроса статуса:

  setorderinfo — Корневой контейнер. Обязательный элемент.

  • auth — Авторизация. Обязательный элемент.
  • order — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера order. Атрибут ordercode — внутренний код заказа.
  • status — Новый статус заказа. Доступны статусы из раздела #Описание полей ответа статусов, кроме AWAITING_SYNC и NEW.
  • eventtime — Дата и время изменения статуса. Обязательно при указании статуса.
  • message — Текст сообщения Инфо о доставке.
  • paytype — Тип оплаты заказа. Допустимые значения CASH/CARD.
  • items — Контейнер для описания вложений item . Атрибуты:
  • code — Код вложения.
  • quantity — Количество доставленных единиц вложения.
  • reason — Причина недоставки, выбирается из соответствующего списка статусов.
  • image — Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту base64. Контейнер order может содержать более одного контейнера image. Атрибут:
  • filename — Имя файла.

  Получение документов для печати

  Пример запроса получения печатных форм:

  waybill — Корневой контейнер. Обязательный элемент

  • auth — Авторизация. Обязательный элемент
  • orders — Список заказов для получения печатных форм. Содержит тэги order с атрибутами:
  • orderno — шифр заказа
  • ordercode — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут ordercode
  • form — Формат накладной. Не обязательный элемент. Принимает значения:
  • 1 — Подробная накладная (по-умолчанию)
  • 2 — Наклейки Zebra
  • 3 — Наклейки на страницу формата А4
  • 4 — Акты приема-передачи

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

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

  Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений — статуса доставки, статуса корреспонденции, времени доставки — то есть заказов, которые ещё не находятся в работе. Возможность отмены заказа есть только у курьерских служб с тарифом «Премиум» и по-умолчанию она выключена, ее нужно отдельно включить: Личный кабинет курьерской службы#Дополнительные настройки.

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

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

  Описание полей запроса статуса:

  cancelorder — Корневой контейнер. Обязательный элемент.

  • auth — Авторизация. Обязательный элемент.
  • order — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера order. Атрибуты:
  • orderno — Шифр заказа.
  • ordercode — Внутренний код заказа.

  Обратите внимание, что должен быть указан хотя бы один из атрибутов orderno или ordercode!

  Справочник городов

  Пример запроса справочника городов:

  Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

  • auth — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.
  • codesearch — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.
  • zipcode — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.
  • kladrcode — Поиск по 13-ти значному коду КЛАДР.
  • fiascode — Поиск по коду ФИАС (AOGUID).
  • code — Поиск по коду в системе.
  • conditions — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
  • city — Поиск по всем населенным пунктам региона.
  • namecontains — Поиск населенных пунктов, название которых содержит указанный текст.
  • namestarts — Поиск населенных пунктов, название которых начинается с указанного текста.
  • name — Поиск населенных пунктов, название которых соответствует указанному тексту.
  • fullname — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
  • country — Поиск только по стране с указанным кодом.
  • limit — Ограничивает вывод результата.
  • limitfrom — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
  • limitcount— Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.
  • countall — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

  В ответе города сортируются по популярности, важности (районные центры и т.д.), и только затем — по алфавиту.

  radius login

Зарегистрирован: 10.08.2011
Пользователь #: 132,945
Сообщения: 1239

Голоса: 19

Зарегистрирован: 24.02.2011
Пользователь #: 128,971
Сообщения: 86

Голоса: 1

Зарегистрирован: 21.04.2010
Пользователь #: 87,015
Сообщения: 62

Голоса: 1

Зарегистрирован: 24.02.2011
Пользователь #: 128,971
Сообщения: 86

Голоса: 1

Зарегистрирован: 24.02.2011
Пользователь #: 128,971
Сообщения: 86

Голоса: 1

Зарегистрирован: 24.02.2011
Пользователь #: 128,971
Сообщения: 86

Голоса: 1

Зарегистрирован: 24.02.2011
Пользователь #: 128,971
Сообщения: 86

Вам также может быть интересно

Обучение программированию

Эффективный способ применения интерфейсов в mdi приложениях

Многооконный интерфейс. Создание MDI-приложения , страница 3 Вместо дополнительных байт окна приложение может использовать

Обучение программированию

Язык xml стилевые таблицы xsl

Отображение XML с использованием XSLT При помощи XSLT вы можете преобразовывать XML документ в

Обучение программированию

Эффекты с изображениями

Как сделать — визуальные эффекты изображениям Узнайте, как добавить визуальные эффекты к изображениям. Фильтры

Обучение программированию

Язык xml схемы данных

Понимание XML Узнайте, как Расширяемый язык разметки (Extensible Markup Language — XML) облегчает универсальный

Обучение программированию

Юмор пиво для программиста

ХАЙФХАК: ПРОГРАММИСТ ВЗЛОМАЛ СИСТЕМУ, ЧТОБЫ ПОПИТЬ ПИВО БЕСПЛАТНО / пиво :: geek новости ::

Обучение программированию

Язык обработки данных awk

Примеры команды AWK в Linux Введение AWK назван в честь фамилии его авторов: Альфред

Обучение программированию

Я загружаю timagelist динамически как сделать картинки из timagelist прозрачными

Я загружаю timagelist динамически как сделать картинки из timagelist прозрачными? Элемент управления ImageList содержит

Обучение программированию

Язык преобразований xsl (xslt)

Введение в XSLT XSLT представляет собой способ для XML-документов в другие XML или документы

Обучение программированию

Является ли указанная страница — домашней (IE)

Является ли указанная страница — домашней? (IE) При создании новой вкладки (about:Tabs) в IE9

Обучение программированию

Язык преобразований XSLT

Справочник по интерфейсу администратора Ссылки Назад «> Вверх Вперед Опубликованные SQL View > XSLT

Обучение программированию

Ядро и процессы

Что такое ядро в биологии? Строение и функции ядра В каждой живой клетке протекает

Обучение программированию

Язык программирования alfa

Язык программирования alfa По питанию контроллеры делятся на два типа: с питанием 220 В

Обучение программированию

Язык cc

C++ — Базовый синтаксис Когда мы рассматриваем программу на C ++, ее можно определить

Обучение программированию

Язык рефал

Язык рефал Ура! Сегодня, 30.05.2005, наконец появилась адаптированная к современным платформам Windows-(95/98/ME/NT/2000/XP) и UNIX

Обучение программированию

Эффект pазвивающегося флага

Scrontch’s Flag Designer Design Your Flag! Generates Scalable Vector Graphics (SVG). This App requires

Обучение программированию

Язык sql

SQL-Урок 1. Язык SQL. Основные понятия. Для того, чтобы начать изучать SQL нам нужно

Обучение программированию

Язык с

C++ с нуля Этот самоучитель создан для тех, кто хочет освоить основы программирования на

Обучение программированию

Эффект горящей надписи

Простой огненный текст в Фотошопе Конечный результат: Ресурсы урока: Шаг 1 Создайте новый документ

Обучение программированию

Язык xml documents type definitions (dtd)

Язык XML — практическое введение . Documents Type Definitions (DTD) В XML- документах DTD

Обучение программированию

Языки и грамматики простейший компилятор

ГРАММАТИКА ЯЗЫКОВ ПРОГРАММИРОВАНИЯ Описанию грамматики языка предшествует описание его алфавита. Алфавит любого языка состоит

Обучение программированию

Эффект ледяной надписи

Ледяной текст в Фотошопе Конечный результат: Ресурсы урока: 1. Создание фона Шаг 1 Создайте

Обучение программированию

Язык xml dom совместимые анализаторы

XML-анализаторы в java XML как набор байт в памяти, запись в базе или текстовый

Обучение программированию

Языки описания пользовательских интерфейсов

Языки описания пользовательских интерфейсов Язык описания интерфейсов Язык описания интерфейсов (IDL), используемый OMG определяет

Обучение программированию

Эффект линзы (watcom c)

Эффект линзы (watcom c) Просветляющие покрытия от ZEISS Высококачественные линзы требуют высоколассного подхода: защита,