АНС Экспресс – курьерская служба доставки по Москве и всей России
Доставка писем, документов, посылок
интернет магазинов
Ваш город: Ашберн
Не ваш город?
Москва
Санкт-Петербург
8 (495) 241-3508
Заказать звонок
ул. Кантемировская, д.59а
info@ans-express.ru

Доставка интернет магазинам

Наши
возможности
Доставка
по России
Страхование
отправлений
Кассовое
обслуживание
Оплата
картой
Примерка
20 мин
API
интеграция
SMS
оповещение
Возврат
денег
Хранение и
комплектация
Частичный
возврат
115447 г. Москва ул. Кантемировская, д.59а АНС Экспресс 8 (495) 241-3508 RUB

API интеграция

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

По всем вопросам связаным с API интеграцией звоните по телефону 8 (495) 241-3508 или пишите на почту info@ans-express.ru. Тестовая площадка доступна по адресу https://home.courierexe.ru/api/ логин test пароль testm, параметр extra - 8. Клиент отправляет запросы к сервису, методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML. Кодировка - UTF-8. Разделитель целой и дробной частей чисел - используется символ точки. Даты представляются в виде YYYY-MM-DD, время - HH:MM. В силу особенностей языка XML, некоторые символы в тексте должны быть заменены: & на & < на< > на > " на "

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

 

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

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

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

  • company - Компания-получатель. Должно быть заполнено company ИЛИ person!
  • person - Контактное лицо. Должно быть заполнено company ИЛИ person!
  • phone - елефон. Можно указывать несколько телефонов, E-mail в этом поле.
  • town - Город. В системе города привязываются к справочнику, поэтому город должен иметь правильное полное написание. Так же можно в этом поле указать числовое значение - код населенного пункта из справочника городов. При указании названия возможно появление ошибки, если населенных пунктов с таким названием в справочнике несколько.
  • paytype - Тип оплаты заказа получателем. Принимает значения:
    CASH Наличными (по-умолчанию)
    CARD Картой
    NO Без оплаты
    OTHER Прочее (платежные системы и т.д.)
  • zipcode - Почтовый индекс.
  • weight - Общий вес заказа.
  • quantity - Количество мест.
  • service -
  • price - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
  • return - Признак необходимости возврата.
  • return_service - Режим возврата (тип услуги) передается код из соответствующего справочника.
  • enclosure - Вложение
  • inshprice - Объявленная ценность.
  • instruction - Поручение - Примечание.
  • items - Контейнер для описания вложенных товаров. Не обязательный контейнер.
  • item - Название товара.
  • quantity - Количество мест.
  • mass - Масса единицы товара.
  • retprice - Цена единицы товара.
  • barcode - Штрих-код товара.
  • article - Артикул товара. Внимание! Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к справочнику номенклатуры . Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если товар не на ответственном хранении - артикул указывать не нужно. Позиция попадет в систему просто текстом.

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

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

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

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

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

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

0 - Ошибок нет.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

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

  • statusreq -Корневой контейнер. Обязательный элемент.
  • auth -Авторизация. Обязательный элемент.
  • orderno -Номер заказа. Не обязательный элемент.
  • orderno2 -Номер заказа из срочных. Не обязательный элемент.
  • datefrom -Дата "с". Обязательный элемент.
  • dateto -Дата "по". Обязательный элемент.
  • quickstatus -Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.
  • done -Может принимать значения:
  • Только не доставленные ONLY_NOT_DONE
  • Только доставленные ONLY_DONE
  • Все пусто
  • changes -может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные, кроме quickstatus, игнорируются. Описание данного режима приведено здесь: Передача только изменившихся статусов

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

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

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

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

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

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

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

  • атрибут ordercode контейнера order - внутренний код заказа в системе, применяется для некоторых внутренних операций.
  • атрибут givencode контейнера order - внутренний код заказа в системе, применяется для некоторых внутренних операций.
  • атрибут returns контейнера item - Количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.
  • атрибут code контейнера item - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
  • coords в контейнере receiver - координаты получателя.
  • currcoords - текущие координаты заказа. Атрибуты:

    lat - широта

    lon - долгота

    accuracy - точность в метрах

    RequestDateTime - дата/время последнего обновления координат.

  • deliveryprice - стоимость доставки в валюте расчетов с клиентом.
  • status - статус доставки.
  • customstatecode - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
  • deliveredto - Данные о вручении, либо причина недоставки.
  • delivereddate - Дата вручения.
  • deliveredtime - Время вручения. В случае недоставки может быть пустым.

Статус может принимать следующие значения:

NEW - Новый

ACCEPTED - Получен складом

DELIVERY - Доставляется

COURIERRETURN - Возвращено курьером

COMPLETE - Доставлен

CANCELED - Не доставлен

PARTIALLY - Доставлен частично

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

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

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

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

orderno

status

delivereddate

deliveredtime

deliveredto

receiver->date

receiver->address

price

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

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

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

Внимание! При данном способе передачи система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее - изменение статуса по нему не попадет в результат выполнения данного запроса.

Внимание! Система всегда выдает текущий статус. Т.е. Вы можете одним запросом получить статус "NEW", а следующим - "COMPLETE". В помежутке между запросами отправление могло пройти через несколько промежуточных статусов.

Внимание! Система не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.

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

 

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

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

  • codesearch -Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.
  • zipcode -Поиск по индексу. Система найдет первый населенный пункт, который соответствует указанному индексу. Поскольку один почтовый индекс может распространяться на несколько населенных пунктов - поиск может выдать не тот пункт, который ожидается. Данный параметр может не поддерживаться в конкретной установке системы.
  • code -Поиск по коду в системе.
  • conditions -Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".
  • city -Поиск по всем населенным пунктам региона.
  • namecontains -Поиск населенных пунктов, название которых содержит указанный текст.
  • namestarts -Поиск населенных пунктов, название которых начинается с указанного текста.
  • name - Поиск населенных пунктов, название которых соответствует указанному тексту.
  • fullname -Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
  • limit -Ограничивает вывод результата.
  • limitfrom -Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.
  • limitcount -Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.
  • countall -YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.

Пример ответа:

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

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

 

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

Пример ответа:

Справочник улиц

 

Пример запроса справочника улиц:

  • conditions -Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".
  • town -Обязательное поле. Название или код населенного пункта
  • namecontains -Поиск населенных пунктов, название которых содержит указанный текст.
  • namestarts -Поиск населенных пунктов, название которых начинается с указанного текста.
  • name -Поиск населенных пунктов, название которых соответствует указанному тексту.
  • fullname -Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
  • limit -Ограничивает вывод результата.
  • limitfrom -Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию - 0.
  • limitcount -Задает количество записей результата, которые нужно вернуть. По-умолчанию - 10000.
  • countall -YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено - в ответе не указываются totalcount и totalpages.

Пример ответа:

В ответе улицы сортируются по алфавиту.

Справочник номенклатуры

 

Пример запроса справочника номенклатуры:

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

  • codesearch -Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.
  • code -Поиск по внутреннему коду системы.
  • article -Поиск по артикулу.
  • barcode -
  • conditions - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".
  • namecontains - Поиск товаров, название которых содержит указанный текст
  • namestarts - Поиск товаров, название которых начинается с указанного текста.
  • name -Поиск товаров, название которых соответствует указанному тексту.
  • quantity -Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. Это поле может быть недоступным в некоторых установках.
  • limit -Ограничивает вывод результата.
  • limitfrom -Задает номер записи результата, начиная с которой выдавать ответ.
  • limitcount -Задает количество записей результата, которые нужно вернуть.

Пример ответа:

Описание полей:

  • code - Внутренний идентификатор, присвоенный системой.
  • article - Артикул, назначенный клиентом (поставщиком).
  • barcode - Штрих-код производителя.
  • name - Наименование.
  • retprice - Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.
  • weight - Масса в килограммах.
  • length - Длина в сантиметрах.
  • width - Ширина в сантиметрах.
  • height - Высота в сантиметрах.
  • CountInPallet - Количество штук в паллете.
  • HasSerials - Требует учета серийных номеров. Принимает значения 1 - да, 0 - нет.
  • CountryOfOrigin - Наименование страны происхождения на русском языке.
  • Message - Комментарий.
  • Message2 - Дополнительный комментарий.
  • quantity - Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. Это поле может быть недоступным в некоторых установках.
  • reserved - Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. Это поле может быть недоступным в некоторых установках.

Справочник пунктов самовывоза (not yet supported)

 

Справочник типов доставки

 

Пример запроса типов доставки:

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

Расчет стоимости доставки

 

Пример запроса стоимости доставки:

Пример ответа стоимости доставки: