English version: http://api.grastin.ru/indexen.html

История изменений

Общие положения

Функции поиска

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

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

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

Получение списка складов приёмки

Получение списка регионов доставки

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

Получение списка доступных индексов Boxberry

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

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

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

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

Получение списка отчетов агента

Получение списка договоров

Получение списка заказов по статусу

Получение списка офисов транспортных компаний

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

Проверка почтового баланса

Получение списка услуг по доставке

Отслеживание заказов Почта РФ

Функции создания отправлений

Добавление заказа в курьерскую службу

Добавление заказа Почта России

Добавление заказа Boxberry

Добавление заказа Hermes

Добавление заказа партнерских пунктов

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

Печатные формы

Печать акта приема-передачи

Печать маркировок

Печать маркировки через xml-запрос

Тексты ошибок

Пример подключения

Пример подключения к API используя PHP

Пример подключения к API из 1С

Техподдержка

Политика создания сторонних приложений интеграции.

  1. История изменений

03.09.2018

В метод получения информации по заказам orderinformation в ответ в описание товаров добавлено поле добавлено поле returnamount со значением количества товара на возврат в заказе.  

04.07.2018

В метод printmark для печати маркировок добавлен необязательный параметр печати этикетки на отдельном листе onepersheet.

18.06.2018        

В ответе метода selfpickup  добавлены поля exchange и takeaway.

06.04.2018

Добавлен метод отслеживания заказов Почта РФ trackingpost.

01.02.2018

Добавлен метод получения списка пунктов партнеров partnerselfpickup.

Добавлен метод добавления заказов на доставку через пункты партнеров neworderpartner.  

23.01.2018

В метод получения информации по заказам orderinformation в ответ добавлено поле StatusHistory со значением истории статусов, которые были у заказа.На момент обновления статус заполняется у заказов, отправленных через Boxberry.  

19.01.2018

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

01.11.2017

В ответе метода selfpickup было добавлено поле dressingroom, в котором отмечается есть ли на ПВЗ примерочная комната.

27.10.2017

В метод получения информации по заказам orderinformation в ответ добавлено поле service со значением кода услуги доставки заказа.

17.07.2017

Добавлен раздел описания текстов ошибок.

02.06.2017

Добавлен метод PostBalance для получения описания почтового баланса клиента.

29.05.2017

В ответе метода contractlist добавлено поле Idregion, в котором указывается уникальный идентификатор региона доставки, на который создан договор.

14.05.2017

Добавлен метод printmark для печати маркировок через xml-запрос.

08.05.2017

В ответе метода selfpickup добавлены поля Largesize и OnlyLargesize , в которых отмечается работает ли ПВЗ с крупногабаритным грузом  и работает ли он только с крупногабаритным грузом.

02.05.2017

Изменен адрес техподдержки на helpdesk@grastin.ru

 

01.05.2017

В ответе метода selfpickup было добавлено поле regional, в котором отмечается работает ли ПВЗ по областному тарифу.

В методе расчета стоимости CalcShipingCost добавилось необязательное поле regional. Если поле равно true стоимость будет рассчитана доставка по областному тарифу  

07.03.2017

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

boxberryselfpickup

boxberrypostcode

hermesselfpickup

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>hermesselfpickup</Method>

            <City>моск</City>

</File>

31.01.2017

Добавлена возможность получения информации о возможности доставки по координатам. Метод deliverability

30.01.2017

В метод получения информации по заказам orderinformation в ответ добавлены поля списка товаров заказа GoodsList

24.01.2017

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

<good

        article = "A1"

        name = "Товар 1"

        cost = "1000"

        amount = "4"/>

Методы:

newordercourier

newordermail

neworderboxberry

neworderhermes

02.12.2015

Метод tcofficelist возвращает перечень офисов транспортных компаний.

Метод newordercourier расширен состав полей для случая передачи заказа через транспортную компанию.

15.10.2015

Метод selfpickup возвращает ссылку на изображение схемы проезда к пункту самовывоза.

17.07.2015

Добавление услуги в метод добавления доставки Почтой РФ newordermail.

Заполнение данного параметра станет обязательным с 01.08.2015.

22.06.2015

Для всех методов добавления заказов добавлен тег указания электронной почты - email.

В методы Получение информации по заказу и Получение списка отчетов агента добавлен узел ответа IdContract.

21.05.2015

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

Получение списка заказов по статусу

06.04.2015 

В методы возвращения списка пунктов самовывоза добавился вывод информации про географические координаты пункта latitude и longitude.

23.03.2015 

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

23.03.2015 

В метод получение списка пунктов самовывоза Boxberry добавлен вывод информации про возможность оплаты банковской картой. Поле - acquiring

11.03.2015 

В метод получения информации по заказу добавлен вывода информации по штрих-кодам мест (Places).

28.02.2015 

Добавление возможность работы с заказами службы Hermes-DPD. Получение списка пунктов самовывоза. Создание заказа на доставку:

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

Добавление заказа Hermes

27.01.2015

В метод получения списка пунктов самовывоза Boxberry поле fullprepayment.

02.12.2014

В метод информации по заказам и информации по отчетам агента добавлено поле DistanceCost.

25.11.2014

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

В метод печати акта приемо-передачи добавлены параметры:

21.11.2014

В метод orderinformation добавлен SecondStatus, в котором возвращается статус партнёрской службы доставки.

17.11.2014

Добавлен метод для возвращения списка отчетов агента agentreportlist.

03.11.2014

Обновлён пример подключения к API из 1С

30.10.2014

В методе boxberryselfpickup расширен состав информации про пункт самовывоза. Добавлены график работы, описание проезда, тарифная зона, срок доставки.  

29.10.2014

В методе orderinformation  становится обязательным указание номера проверяемого заказа.

27.10.2014

С целью указания уникального сайта для заказа добавлен тег sitename в методы добавления заказов:

newordercourier

newordermail

neworderboxberry 

Данная информация отображается в маршрутном листе курьера.

01.10.2014 

Добавление возможности добавления заказов Boxberry. Добавились методы:

boxberryselfpickup

boxberrypostcode

neworderboxberry

  1. Общие положения         

Начало работы

Прежде чем приступить к работе с API, необходимо получить у Вашего менеджера API-ключ.

Ограничение обращений по API

Для каждого ключа есть ограничение на количество обращений к API в размере 10000 запросов в сутки. Ошибка, указывающая на превышение лимита обращений: «limit is 10000 requests».

Формат запроса

Отправляется xml-строка методом POST в параметре XMLPackage по адресу API:

http://api.grastin.ru/api.php. Данные передаются в кодировке UTF-8.

Обязательные теги в xml-запросах

Тег

Описание

API

API-ключ, который Клиент получает у менеджера службы доставки

Method

Наименование метода, который выполняется в запросе. Возможные варианты:

  • Orderinformation
  • Selfpickup
  • Warehouse
  • DeliveryRegion
  • StatusHistory
  • NewOrderCourier
  • NewOrderMail
  • RequestForIntake
  • PrintActOfReceiving

  1. Функции поиска

  1. Получение информации по заказу

Метод: orderinformation

Описание содержания тегов xml-запроса

Тег

Описание

order

Номер заказа.

datedeliverystart

Начало периода отбора по дате доставки. Задается в формате ddmmMMMM

datedeliveryend

Конец периода отбора по дате доставки. Задается в формате ddmmMMMM

Описание содержания тегов xml-ответа

Тег

Описание

number

Номер заказа.

Status

Статус заказа

"draft" - черновик, принят через API или личный кабинет и ждет рассмотрения логиста;

"new" - Новый. Рассмотрен логистом, ждет получения заказа на складе;

"return" - Возврат;

"done" - Выполнен;

"shipping" - На доставке. Заказ отгружен курьеру;

"received" - Получен от клиента. Заказ получен на склад от клиента;

"canceled" - Заказ отменен;

"prepared for shipment" - Заказ подготовлен к отгруке курьеру в машину;

"problem" - Проблемный заказ.

“returned to customer” - возвращен клиенту;

“decommissioned” - списан;

“unknown” - ошибка определения статуса заказа.

StatusHistory

История статусов службы доставки

Service

Код услуги доставки

SecondStatus

Статус заказа у партнёрской службы доставки. Список статусов:

Возврат

Возврат поставщику подтвержден

Возвращено в ИМ

Возвращено в пункт приема

Временное хранение

Вручение

Выдана

Выдано

Готовится к возврату

Доставлена в пункт выдачи

Доставлена на транзитный терминал

Досылка почты

Неудачная попытка вручения

Новая

Обработка

Окончательно потеряна

Отправлено в город назначения

Отправлено в пункт приема

Передано на курьерскую доставку

Передано на сортировку

Передача на временное хранение

Получена поставщиком

Поступило в пункт выдачи

Потеряна

Прием

Принята в пункте выдачи

Проблемы при доставке

Просрочена

StatusDateTime

Дата-время установки статуса заказа (формат 01.01.0001 00:00)

Weight

Вес заказа (в граммах)

TrackingNumber

Почтовый идентификатор. Для заказов Почта России выводится почтовый идентификатор для отслеживания посылки.

Cost

Стоимость услуг службы доставки.

CostPost

Стоимость услуг Почты России (для заказов, которые отправляются через Почту России, для остальных заказов значение не заполнено)

Barcode

Штрих-код заказа

DeliveryRegion

Регион доставки (информация для печати маркировки заказов)

GeographicArea

Георайон (информация для печати маркировки заказов)

AgentReportNumber

Номер отчета агента.

Sum

Сумма заказа (по отчету агента)

SumRefund

Сумма возврата (по отчету агента)

PaidOrder

Оплачено за заказ (по отчету агента)

Commission

Комиссия агента (по отчету агента)

ShipingCost

Стоимость доставки (по отчету агента)

SmsInform

Стоимость услуги sms-информирования (по отчету агента)

ShipingCostAdditionally

Дополнительная стоимость доставки (по отчету агента)

DistanceCost

Стоимость доставки за расстояние (по отчету агента)

SumPayment

Сумма оплаты (по отчету агента)

DateDelivery

Дата отгрузки заказа (формат 01.01.0001)

IsSelfPickup

Заказ пункта самовывоза (принимает значение “true” или “false”)

RemainingDaysOfStorage

Оставшееся количество дней хранения. Рассчитывается для заказов со статусом «shipping».

Places

Штрих-коды каждого места заказа по отдельности.

IdContract

Уникальный идентификатор договора, по которому проходит этот заказ.

GoodsList

article

name

cost

vat

amount

Перечень товаров заказа

  • Артикул
  • Наименование
  • Цена
  • НДС
  • Количество

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>orderinformation</Method>

<Orders>

<Order>Заказ1</Order>

</Orders>

</File>

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

<Order>

<Number>Заказ1</Number>

<Status>New</Status>

<StatusDateTime>01.10.2012 17:41</StatusDateTime>

<Weight>3200</Weight>

<TrackingNumber>1234567890</TrackingNumber>

<Cost>80</Cost>

<CostPost>100</CostPost>

<Barcode>1250000063959</Barcode>

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

<GeographicArea>ц12</GeographicArea>

<DateDelivery>01.10.2012</DateDelivery>

<IsSelfPickup>false</IsSelfPickup>

<IdContract>a4636356-25d7-11e3-8e73-00155d030305</IdContract>

<RemainingDaysOfStorage/>

<Places>

<Place Number="1" Barcode="1250009780451"/>

<Place Number="2" Barcode="1250009780468"/>

<Place Number="3" Barcode="1250009780475"/>

</Places>

<GoodsList>

<Good

article="А2"

name="Подушка перьевая"

cost="3200"

vat="200"

amount="1"

returnamount="0"/>

</GoodsList>

</Order>

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

Метод: selfpickup

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Name

Название пункта самовывоза

latitude

Географическая широта пункта самовывоза

longitude

Географическая долгота пункта самовывоза

drivingdescription

Описание схемы проезда к пункту самовывоза

linkdrivingdescription

Ссылка на изображение схемы проезда к пункту самовывоза

id

Код пункта самовывоза

city

Населённый пункт

phone

Телефон

email

Электронная почта

timetable

Режим работы

title

Наименование

metrostation

Ближайшая станция метро

paymentcard

Может принимать карты

regional

Работает как областной пункт самовывоза

largesize

Пункт выдает крупногабарит

onlylargesize

Пункт выдает только крупногабарит

dressingroom

В пункте есть примерочная комната

exchange

отвечает за доступность обмена товара в пункте самовывоза;

takeaway

отвечает за доступность забора товара в пункте самовывоза;

address

Адрес пункта самовывоза

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>selfpickup</Method>

</File>

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

<SelfpickupList>

        <Selfpickup>

                <Name>Самовывоз МСК, Балашиха, проспект ленина 8</Name>

                <drivingdescription>

                От остановки МФЦ идем к светофору в направлении магазина Евросеть, на светофоре поворачиваем налево, идем мимо Subway до конца дома в сторону церкви и между домом №8 и №6 будет вход в подвальное помещение с вывеской студия красоты Caramel. Спускаемся по лестнице, заходим в левую дверь и вы на месте.

                </drivingdescription>

                <linkdrivingdescription>

                https://grastin.ru/assets/images/samovyvoz/grastin_mo1.jpg

                </linkdrivingdescription>

                <latitude>55.796663</latitude>

                <longitude>37.933501</longitude>

                <id>f83aec04-2b12-11e7-a8e8-0050569bade2</id>

                <city>Балашиха</city>

                <phone/>

                <email/>

                <timetable>Ежедневно с 11:00 до 20:00</timetable>

                <title>МСК-16, Балашиха</title>

                <metrostation/>

                <paymentcard>true</paymentcard>

                <regional>true</regional>

                <largesize>false</largesize>

                <onlylargesize>false</onlylargesize>

        </Selfpickup>

        <Selfpickup>

                <Name>Самовывоз МСК, Алтуфьевское шоссе 80</Name>

                <drivingdescription>

                м. Алтуфьево. Последний вагон из центра, из стеклянных дверей метро налево, выход из перехода по ступенькам направо. Далее двигаться прямо по Алтуфьевскому шоссе до ТД Арфа. Поднимайтесь на 2-ой этаж, повернуть направо, затем снова направо и Вы на месте!

                </drivingdescription>

                <linkdrivingdescription>

                https://grastin.ru/assets/images/samovyvoz/grastin_m17.jpg

                </linkdrivingdescription>

                <latitude>55.894323</latitude>

                <longitude>37.588242</longitude>

                <id>7020f0cf-30c3-11e7-8cc7-0050569bade2</id>

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

                <phone/>

                <email/>

                <timetable/>

                <title>МСК-17, Алтуфьево</title>

                <metrostation>м. Алтуфьево</metrostation>

                <paymentcard>true</paymentcard>

                <regional>false</regional>

                <largesize>false</largesize>

                <onlylargesize>false</onlylargesize>

        </Selfpickup>

</SelfpickupList>

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

Метод: ordertakepoint

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Name

Название пункта самовывоза

latitude

Географическая широта пункта самовывоза

longitude

Географическая долгота пункта самовывоза

drivingdescription

Описание схемы проезда к пункту самовывоза

linkdrivingdescription

Ссылка на изображение схемы проезда к пункту самовывоза

id

Код пункта самовывоза

city

Населённый пункт

phone

Телефон

email

Электронная почта

timetable

Режим работы

title

Наименование

takelargesize

Пункт может принимать крупногабаритные заказы

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>ordertakepoint</Method>

</File>

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

<OrderTakePointList>

<OrderTakePoint>

<Name>Самовывоз МСК, Балашиха, ул. Советская д. 3</Name>

<drivingdescription>

От остановки МФЦ идти к магазину Ароматный мир, пройти налево между домами, с торца здания вход на цокольный этаж с надписью «Комиссионный магазин». Спуститься по лестнице, пройти по коридору до конца и направо, слева находится Пункт выдачи заказов Грастин.

</drivingdescription>

<linkdrivingdescription>https://grastin.ru/assets/images/samovyvoz/grastin_m16.jpg</linkdrivingdescription>

<latitude>55.796663</latitude>

<longitude>37.933501</longitude>

<id>f83aec04-2b12-11e7-a8e8-0050569bade2</id>

<city>Балашиха</city>

<phone/>

<email/>

<timetable>Ежедневно с 11:00 до 20:00</timetable>

<title>МСК-16, Балашиха</title>

<metrostation/>

<takelargesize>false</takelargesize>

</OrderTakePoint>

</OrderTakePointList>

  1. Получение списка складов приёмки

Метод: warehouse

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование склада приёмки заказов

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>warehouse </Method>

</File>

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

<WarehouseList>

        <Warehouse>

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

        </Warehouse>

        <Warehouse>

                <Name>Санкт-Петербург</Name>

        </Warehouse>

</WarehouseList>

  1. Получение списка регионов доставки

Метод: DeliveryRegion

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование региона доставки

IsCourier

Признак курьерской доставки по региону

Id

Уникальный идентификатор региона доставки

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>DeliveryRegion</Method>

</File>

 

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

<Regions>

        <Region>

                <Name>Почта</Name>

                <IsCourier>false</IsCourier>

                <Id>e92ae8a2-074c-11e2-a6e5-00152d030203</Id>

        </Region>

        <Region>

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

                <IsCourier>true</IsCourier>

                <Id>e92ae8a3-074c-11e2-a6e5-00152d030203</Id>

        </Region>

        <Region>

                <Name>Санкт-Петербург</Name>

                <IsCourier>true</IsCourier>

                <Id>e92ae8a4-074c-11e2-a6e5-00152d030203</Id>

        </Region>

</Regions>

  1. Получение списка пунктов самовывоза Boxberry

Метод: boxberryselfpickup

Описание содержания тегов xml-запроса

Тег

Описание

City

Необязательный параметр. Часть строки населенного пункта для фильтрации.

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование пункта самовывоза

Id

Уникальный идентификатор пункта самовывоза boxberry

schedule

Часы работы пункта

deliveryperiod

Срок доставки

drivingdescription

Описнаие схемы проезда

tariffzone

Тарифная зона

fullprepayment

Признак полной предоплаты в пункте самовывоза.

acquiring

Возможность оплаты банковской картой.

latitude

Географическая широта пункта самовывоза

longitude

Географическая долгота пункта самовывоза

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>boxberryselfpickup</Method>

</File>

 

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

<SelfpickupBoxberryList>

        <SelfpickupBoxberry>

                <Name>

675000, г.Благовещенск, ул.Амурская, д. 180, офис 2

                </Name>

                <Id>74682f61-117f-11e4-a9f5-00155d030401</Id>

                <schedule>пн. - пт.: 8:30 - 17:30</schedule>

                <deliveryperiod>14</deliveryperiod>

                <drivingdescription>

офис расположен в административном здании, по ул.Амурской между ул.Б.Хмельницкого и ул.Шевченко (основной ориентир: напротив ОАО Азиатско-Тихоокеанского Банка). У здания предусмотрены места для парков

                </drivingdescription>

                <tariffzone>4</tariffzone>

<fullprepayment>true</fullprepayment>

        </SelfpickupBoxberry>

        <SelfpickupBoxberry>

                <Name>

                665708, г. Братск, Центральный жилрайон, ул. Комсомольская, 32/2

                </Name>

                <Id>74682eff-117f-11e4-a9f5-00155d030401</Id>

                <schedule>пн. - пт.: 08:00 - 19:00, сб.: 10:00 - 16:00</schedule>

                <deliveryperiod>15</deliveryperiod>

                <drivingdescription>

Здание находится через дорогу от развлекательного центра "Формула", в помещении агентства недвижимости "Норд". Проезд троллейбусами № 1, № 1 укороченный и № 2, маршрутные автобусы № 1 и № 2, остановка

                </drivingdescription>

                <tariffzone>3</tariffzone>

<fullprepayment>false</fullprepayment>

        </SelfpickupBoxberry>

</SelfpickupBoxberryList>

  1. Получение списка доступных индексов Boxberry

Метод: boxberrypostcode

Описание содержания тегов xml-запроса

Тег

Описание

City

Необязательный параметр. Часть строки населенного пункта для фильтрации.

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование индекса

Id

Уникальный идентификатор индекса boxberry

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>boxberrypostcode</Method>

</File>

 

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

<PostcodeBoxberryList>

        <PostcodeBoxberry>

                <Name>690920 Владивосток ПРИМОРСКИЙ КРАЙ</Name>

                <Id>74682ef9-117f-11e4-a9f5-00155d030401</Id>

        </PostcodeBoxberry>

        <PostcodeBoxberry>

                <Name>690922 Владивосток ПРИМОРСКИЙ КРАЙ</Name>

                <Id>74682efa-117f-11e4-a9f5-00155d030401</Id>

        </PostcodeBoxberry>

        <PostcodeBoxberry>

                <Name>690961 Владивосток ПРИМОРСКИЙ КРАЙ</Name>

                <Id>74682efb-117f-11e4-a9f5-00155d030401</Id>

        </PostcodeBoxberry>

</PostcodeBoxberryList>

  1. Получение списка пунктов самовывоза Hermes

Метод: hermesselfpickup

Описание содержания тегов xml-запроса

Тег

Описание

City

Необязательный параметр. Часть строки населенного пункта для фильтрации.

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование пункта самовывоза

Id

Уникальный идентификатор пункта самовывоза Hermes

latitude

Географическая широта пункта самовывоза

longitude

Географическая долгота пункта самовывоза

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>hermesselfpickup</Method>

</File>

 

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

<SelfpickupHermesList>

<SelfpickupHermes>

<Name>675000, г.Благовещенск, ул.Амурская, д. 180, офис 2</Name>

<Id>6f62bec6-be5c-11e4-b950-00155d030231</Id>

</SelfpickupHermes>

</SelfpickupHermesList>

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

Метод: partnerselfpickup

Описание содержания тегов xml-запроса

Тег

Описание

City

Необязательный параметр. Часть строки населенного пункта для фильтрации.

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование пункта

Id

Уникальный идентификатор пункта

latitude

Географическая широта пункта

longitude

Географическая долгота пункта

city

Город, в котором расположен пункт

schedule

Расписание работы пункта

drivingdescription

Описание схемы проезда к пункту

paymentcard

Может принимать карты

linkdrivingdescription

Ссылка на изображение схемы проезда к пункту самовывоза

regional

Работает как областной пункт самовывоза

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>partnerselfpickup</Method>

</File>

 

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

<SelfpickupPartnerList>

<SelfpickupPartner>

<Name>Балашиха Пролетарская</Name>

<Id>8a5e6512-02a1-11e8-a47f-0050569b6f79</Id>

<city>Балашиха</city>

<schedule>пн-пт:10.00-20.00, сб-вс:10.00-19.00</schedule>

<drivingdescription/>

<latitude>55.762898</latitude>

<longitude>37.892948</longitude>

</SelfpickupPartner>

</SelfpickupPartnerList>

  1. Получение истории статусов заказов

Метод: statushistory

Описание содержания тегов xml-запроса

Тег

Описание

Order

Номер заказа

Описание содержания тегов xml-ответа

Тег

Описание

number

Номер заказа

Status

Статус заказа

"draft" - черновик, принят через API или личный кабинет и ждет рассмотрения логиста;

"new" - Новый. Рассмотрен логистом, ждет получения заказа на складе;

"return" - Возврат;

"done" - Выполнен;

"shipping" - На доставке. Заказ отгружен курьеру;

"received" - Получен от клиента. Заказ получен на склад от клиента;

"canceled" - Заказ отменен;

"prepared for shipment" - Заказ подготовлен к отгрузке курьеру в машину;

"problem" - Проблемный заказ.

“returned to customer” - возвращен клиенту;

“decommissioned” - списан;

“unknown” - ошибка определения статуса заказа.

StatusDateTime

Дата-время установки статуса заказа (формат 01.01.0001 00:00)

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>statushistory</Method>

<Orders>

<Order>Заказ1</Order>

</Orders>

</File>

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

<Orders>

        <Order>

<Number>Заказ1</Number>

<Record>

<Status>new</Status>

<StatusDate>06.05.2014 09:32</StatusDate>

</Record>

<Record>

<Status>received</Status>

<StatusDate>07.05.2014 01:22</StatusDate>

</Record>

<Record>

<Status>shipping</Status>

<StatusDate>07.05.2014 05:09</StatusDate>

</Record>

<Record>

<Status>done</Status>

<StatusDate>07.05.2014 17:41</StatusDate>

</Record>

</Order>

</Orders>

  1. Получение стоимости доставки

Метод: CalcShipingCost

Описание содержания тегов xml-запроса

Тег

Описание

number

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

idregion

Уникальный идентификатор региона в который происходит доставка заказа. Список регионов можно получить методом DeliveryRegion. По региону доставки принимается решение по какому правилу рассчитывать доставку заказа.

Если регион доставки будет соответствовать “БоксБерри” значить доставка будет считаться по их тарифам.  

weight

Вес заказа в граммах

assessedsumma

Оценочная стоимость заказа

summa

Сумма заказа

bulky

Признак что заказ крупногабаритный (значение “true” или “false”)

volume

Объем заказа в м3. Необходимо заполнять в случае крупногабаритного заказа. Если заказ не крупногабаритный передается “0”

width

Ширина заказа (см). Необходимо заполнять в случае крупногабаритного заказа. Если заказ не крупногабаритный передается “0”

height

Высота заказа (см). Необходимо заполнять в случае крупногабаритного заказа. Если заказ не крупногабаритный передается “0”

length

Длина заказа (см). Необходимо заполнять в случае крупногабаритного заказа. Если заказ не крупногабаритный передается “0”

selfpickup

Признак что заказ будет отправляться на пункт самовывоза (значение “true” или “false”)

regional

Признак что заказ будет отправляться на пункт самовывоза работающий по областному тарифу (значение “true” или “false”)

transportcompany

Признак что заказ будет отправляться в транспортную компанию (значение “true” или “false”)

paiddistance

Оплачиваемое расстояние в км.

idpickup

ID пункта самовывоза сторонней службы доставки. Берётся на основании метода  boxberryselfpickup.

idpostcode

ID индекса сторонней службы доставки. Берётся на основании метода boxberrypostcode

Примечание:

Для расчёта стоимости доставки Boxberry должен быть заполнен idpickup или idpostcode

Описание содержания тегов xml-ответа

Тег

Описание

number

Номер заказа

status

Статус рассчета стоимости доставки заказа (“Ok” или “Error”)

shippingcost

Стоимость доставки

shippingcostdistance

Стоимость доставки за оплачиваемое расстояние

commission

Комиссия

safetystock

Страховой запас

additionalshippingcosts

Дополнительная стоимость доставки

orderprocessing

Стоимость обработки заказа (используется службой Boxberry)

commissionfastmoney

Комиссия за быстрые деньги (используется службой Boxberry)

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>CalcShipingCost</Method>

<Orders>

  <Order number = "Заказ1"

        idregion= "e92ae8a3-074c-11e2-a6e5-00152d030213"

        selfpickup= "false"

        weight= "100"

        assessedsumma= "3000"

        summa= "3000"

        bulky= "false"

        volume= "0"

        width= "0"

        height= "0"

        length= "0"

        transportcompany= "false"

        paiddistance= "20"

  />

</Orders>

</File>

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

<Orders>

<Order>

<number>Заказ1</number>

<status>Error</status>

<error>Contract for the delivery region not found</error>

</Order>

</Orders>

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

<Orders>

<Order>

<number>Заказ1</number>

<status>Ok</status>

<shippingcost>150</shippingcost>

<shippingcostdistance>200</shippingcostdistance>

<commission>0</commission>

<safetystock>15</safetystock>

</Order>

</Orders>

  1. Получение списка отчетов агента

Метод: agentreportlist

Описание содержания тегов xml-запроса

Тег

Описание

datestart

Начало периода отбора отчетов агента. Задается в формате ddmmMMMM

dateend

Конец периода отбора отчетов агента. Задается в формате ddmmMMMM

Описание содержания тегов xml-ответа

Тег

Описание

number

Номер отчета агента.

Date

Дата отчета агента.

Number (Order)

Номер заказа

Sum

Сумма заказа

SumRefund

Сумма возврата

PaidOrder

Оплачено за заказ

Commission

Комиссия агента

ShipingCost

Стоимость доставки

SmsInform

Стоимость услуги sms-информирования

ShipingCostAdditionally

Дополнительная стоимость доставки

DistanceCost

Стоимость доставки за расстояние

SumPayment

Сумма оплаты

IdContract

Уникальный идентификатор договора, по которому сформирован отчет агента

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>agentreportlist</Method>

<Datestart>01022014</Datestart>

<Dateend>12022014</Dateend>

</File>

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

<AgentReports>

<AgentReport>

<Number>СД0013558</Number>

<Date>12.02.2014 16:25</Date>

<Orders>

<Order>

<Number>2446a</Number>

<Sum>2648</Sum>

<SumRefund>0</SumRefund>

<PaidOrder>2648</PaidOrder>

<Commission>12,25</Commission>

<ShipingCost>140</ShipingCost>

<ShipingCostAdditionally>0</ShipingCostAdditionally>

<DistanceCost>100</DistanceCost>

<SumPayment>2495,75</SumPayment>

<SmsInform>0</SmsInform>

<IdContract>2356e5f1-5f0f-11e4-9968-00155d03041</IdContract>

</Order>

<Order>

<Number>Забор заказа КЛ0029198</Number>

<Sum>0</Sum>

<SumRefund>0</SumRefund>

<PaidOrder>0</PaidOrder>

<Commission>0</Commission>

<ShipingCost>0</ShipingCost>

<ShipingCostAdditionally>0</ShipingCostAdditionally>

<DistanceCost>0</DistanceCost>

<SumPayment>0</SumPayment>

<SmsInform>0</SmsInform>

<IdContract>256e5f1-5f0f-11e4-9968-00155d030401</IdContrac>

</Order>

</Orders>

</AgentReport>

</AgentReports>

  1. Получение списка договоров

Метод: ContractList

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование договора

Id

Уникальный идентификатор договора

Idregion

Уникальный идентификатор региона доставки, на который оформлен договор

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>contractlist</Method>

</File>

 

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

<ContractList>

<Contract>

<Name>Договор №тест (Санкт-Петербург / КЛ)</Name>

<Id>cc5e90a7-2f4f-11e4-89ef-00155d030231</Id>

<Idregion>e92ae8a4-074c-11e2-a6e5-00152d030203</Idregion>

</Contract>

<Contract>

<Name>Договор №тест (Нижний Новгород / КЛ)</Name>

<Id>cc5e90a8-2f4f-11e4-89ef-00155d030231</Id>

<Idregion>4f14dcd5-e633-11e3-be1e-00155d030401</Idregion>

</Contract>

<Contract>

<Name>Договор №тест (Москва / КЛ)</Name>

<Id>a4636356-25d7-11e3-8e73-00155d030305</Id>

<Idregion>e92ae8a3-074c-11e2-a6e5-00152d030203</Idregion>

</Contract>

</ContractList>

  1. Получение списка заказов по статусу

Метод: orderlist

Описание содержания тегов xml-запроса

Тег

Описание

Status

Статус заказа.

"draft" - черновик, принят через API или личный кабинет и ждет рассмотрения логиста;

"new" - Новый. Рассмотрен логистом, ждет получения заказа на складе;

"return" - Возврат;

"done" - Выполнен;

"shipping" - На доставке. Заказ отгружен курьеру;

"received" - Получен от клиента. Заказ получен на склад от клиента;

"canceled" - Заказ отменен;

"prepared for shipment" - Заказ подготовлен к отгруке курьеру в машину;

"problem" - Проблемный заказ.

“returned to customer” - возвращен клиенту;

“decommissioned” - списан.

datestart

Начало периода отбора заказов по дате доставки. Задается в формате ddmmMMMM (необязательный параметр)

 dateend

Конец периода отбора заказов по дате доставки. Задается в формате ddmmMMMM (необязательный параметр)

Описание содержания тегов xml-ответа

Тег

Описание

Number

Номер заказа.

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>orderlist</Method>

<Status>received</Status>

</File>

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

<Orders>

<Number>ИПЧ-HUB-223</Number>

<Number>ИПЧ-BS-509</Number>

<Number>ИПЧ-TD-270(Б)</Number>

<Number>ИПЧ-БВ-2024(1)</Number>

<Number>ИПЧ-IR-29</Number>

<Number>ИПЧ-BS-514</Number>

<Number>ИПЧ-CRE-6732</Number>

<Number>ИПЧ-BS-517</Number>

<Number>ИПЧ-ZR-62</Number>

<Number>ИПЧ-ROG-4605</Number>

<Number>ИПЧ-BS-515</Number>

<Number>BS-328</Number>

<Number>HUB-180</Number>

</Orders>

  1. Получение списка офисов транспортных компаний

Метод: tcofficelist

Описание содержания тегов xml-запроса

Тег

Описание

title

Наименование офиса транспортной компкании.

Id

Уникальный идентификатор офиса транспортной компании

company

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

adres

адрес офиса транспортной компании

Описание содержания тегов xml-ответа

Тег

Описание

Number

Номер заказа.

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>tcofficelist</Method>

</File>

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

<officelist>

<office>

<title>Автотрейдинг</title>

<Id>242a04e5-0656-11e3-b3a1-00155d030305</Id>

<company>Автотрейдинг</company>

<adres>Парковая 16-я, 30, Москва</adres>

</office>

</officelist>

  1. Проверка возможности доставки

Метод: deliverability

Описание содержания тегов xml-запроса

Тег

Описание

Lat

Широта адреса доставки

Lon

Долгота адреса доставки

Описание содержания тегов xml-ответа

Тег

Описание

Answer

Результат проверки

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>deliverability</Method>

<Lat>55.75222</Lat>

<Lon>37.61556</Lon>

</File>

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

<Answer>False</Answer>

  1. Проверка почтового баланса

Метод: PostBalance

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Text

Текстовое описание состояния почтового баланса

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>PostBalance</Method>

</File>

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

<PostBalance>

        <Text>

                Ваш почтовый баланс: за услуги:3 015руб. за пересылку почтовых отправлений:4 897,32руб.

        </Text>

</PostBalance>

  1. Получение списка услуг по доставке

Метод: service

Описание содержания тегов xml-запроса

Тег

Описание

Описание содержания тегов xml-ответа

Тег

Описание

Name

Наименование услуги

CashService

Наличие кассового обслуживания

Code

Код услуги

Pickup

Услуга самовывоза

WithoutMoney

Услуга “Без денег”

Largesize

Крупногабарит

Takegood

Забор товара

TransportCompany

Транспортная компания

PaymentCard

Оплата картой

CourierDelivery

Курьерская доставка

MailRussiaService

Услуга “Почта России”

Purchase

Закупки

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

<file>

<api>024840a2-8800-474a-bd75-39407b93cd90</api>

<method>service</method>

</file>

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

<ServiceList>

<Service>

<Name>Доставка с оплатой</Name>

<CashService>false</CashService>

<Code>2</Code>

<Pickup>false</Pickup>

<WithoutMoney>false</WithoutMoney>

<Largesize>false</Largesize>

<Takegood>false</Takegood>

<TransportCompany>false</TransportCompany>

<PaymentCard>false</PaymentCard>

<CourierDelivery>true</CourierDelivery>

<MailRussiaService>false</MailRussiaService>

<Purchase>false</Purchase>

</Service>

<Service>

<Name>Самовывоз с кассовым обслуживанием</Name>

<CashService>true</CashService>

<Code>7</Code>

<Pickup>true</Pickup>

<WithoutMoney>false</WithoutMoney>

<Largesize>false</Largesize>

<Takegood>false</Takegood>

<TransportCompany>false</TransportCompany>

<PaymentCard>false</PaymentCard>

<CourierDelivery>true</CourierDelivery>

<MailRussiaService>false</MailRussiaService>

<Purchase>false</Purchase>

</Service>

<Service>

<Name>Самовывоз с оплатой</Name>

<CashService>false</CashService>

<Code>6</Code>

<Pickup>true</Pickup>

<WithoutMoney>false</WithoutMoney>

<Largesize>false</Largesize>

<Takegood>false</Takegood>

<TransportCompany>false</TransportCompany>

<PaymentCard>false</PaymentCard>

<CourierDelivery>true</CourierDelivery>

<MailRussiaService>false</MailRussiaService>

<Purchase>false</Purchase>

</Service>

<Service>

<Name>Доставка с оплатой картой</Name>

<CashService>false</CashService>

<Code>19</Code>

<Pickup>false</Pickup>

<WithoutMoney>false</WithoutMoney>

<Largesize>false</Largesize>

<Takegood>false</Takegood>

<TransportCompany>false</TransportCompany>

<PaymentCard>true</PaymentCard>

<CourierDelivery>true</CourierDelivery>

<MailRussiaService>false</MailRussiaService>

<Purchase>false</Purchase>

</Service>

</ServiceList>

  1. Отслеживание заказов Почта РФ

Метод: trackingpost

Описание содержания тегов xml-запроса

Тег

Описание

Order

Номер заказа

Описание содержания тегов xml-ответа

Тег

Описание

number

Номер заказа

OperType

Тип операции

OperDate

Дата операции

OperationAddressIndex

Индекс ОПС

OperationAddressDescription

Название ОПС

OperAttr

Атрибут операции

Mass

Вес

Value

Объявленная ценность

Payment

Наложенный платеж

DestinationAddressIndex

Индекс получателя

DestinationAddressDescription

Адрес получателя

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

<File>

<API>024840a2-8800-474a-bd75-39407b93cd90</API>

<Method>trackingpost</Method>

<Orders>

<Order>Заказ1</Order>

<Order>Заказ2</Order>

</Orders>

</File>

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

<Orders>

        <Order>

<Number>Заказ1</Number>

<Operations>

<Operation Number="1" OperType="Прием" OperDate="13.06.2017 09:30:49" OperationAddressIndex="111537" OperationAddressDescription="Москва 537" OperAttr="Партионный" Mass="0,38" Value="59500" Payment="" DestinationAddressIndex="397164"DestinationAddressDescription="Борисоглебск 4"/>

<Operation Number="2" OperType="Обработка" OperDate="14.06.2017 04:13:40" OperationAddressIndex="140983" OperationAddressDescription="Московский АСЦ Цех Посылок" OperAttr="Сортировка" Mass="0,38" Value="59500" Payment="" DestinationAddressIndex="397164"DestinationAddressDescription="Борисоглебск 4"/>

<Operation Number="3" OperType="Обработка" OperDate="16.06.2017 10:10:56" OperationAddressIndex="140980" OperationAddressDescription="Московский АСЦ Цех Логистики" OperAttr="Покинуло сортировочный центр" Mass="" Value="" Payment=""DestinationAddressIndex="397164" DestinationAddressDescription="Борисоглебск 4"/>

<Operation Number="4" OperType="Обработка" OperDate="16.06.2017 23:30:33" OperationAddressIndex="394960" OperationAddressDescription="Воронеж МСЦ" OperAttr="Прибыло в сортировочный центр" Mass="" Value="" Payment="" DestinationAddressIndex=""DestinationAddressDescription=""/>

<Operation Number="5" OperType="Обработка" OperDate="17.06.2017 01:14:37" OperationAddressIndex="394960" OperationAddressDescription="Воронеж МСЦ" OperAttr="Покинуло сортировочный центр" Mass="" Value="" Payment="" DestinationAddressIndex=""DestinationAddressDescription=""/>

<Operation Number="6" OperType="Обработка" OperDate="17.06.2017 09:05:50" OperationAddressIndex="397189" OperationAddressDescription="Борисоглебск Почтамт" OperAttr="Покинуло сортировочный центр" Mass="" Value="" Payment="" DestinationAddressIndex=""DestinationAddressDescription=""/>

<Operation Number="7" OperType="Обработка" OperDate="17.06.2017 12:37:31" OperationAddressIndex="397164" OperationAddressDescription="Борисоглебск 4" OperAttr="Прибыло в место вручения" Mass="0,38" Value="" Payment="" DestinationAddressIndex="397164"DestinationAddressDescription="Борисоглебск 4"/>

<Operation Number="8" OperType="Вручение" OperDate="17.06.2017 16:01:44" OperationAddressIndex="397164" OperationAddressDescription="Борисоглебск 4" OperAttr="Вручение адресату" Mass="0,38" Value="" Payment="" DestinationAddressIndex="397164"DestinationAddressDescription="Борисоглебск 4"/>

</Operations>

</Order>

</Orders>

  1. Функции создания отправлений

  1. Добавление заказа в курьерскую службу

Метод: newordercourier

Описание содержания тегов xml-запроса

Тег

Описание

number

Номер заказа в Вашей системе

address

Адрес доставки

comment

Комментарий по доставке (не обязательно)

shippingtimefrom

Начало желаемого времени доставки. Задается в формате XX:XX

(Не обязательно. Если не задано - 10:00)

shippingtimefor

Окончание желаемого времени доставки. Задается в формате XX:XX

(Не обязательно. Если не задано - 18:00)

shippingdate

Дата доставки. Задается в формате ddmmMMMM

buyer

ФИО покупателя

summa

Сумма заказа

assessedsumma

Оценочная стоимость заказа

phone1

Номер телефона1 покупателя

phone2

Номер телефона2 покупателя (не обязательно)

service

Код услуги доставки.

1 - Доставка без оплаты

2 - Доставка с оплатой

3 - Доставка с кассовым обслуживанием

4 –Забор товара

5 - Самовывоз без оплаты

6 - Самовывоз с оплатой

7 - Самовывоз с кассовым обслуживанием

8 - Большой доставка без оплаты

9 - Большой доставка и забор наличных

10 - Большой доставка с кассовым обслуживанием

11 - Обмен/забор товара на самовывозе

12 - Транспортная компания

13-Почтовая доставка

14-Посылка онлайн

15-Курьер онлайн

16-Самовывоз с оплатой картой

17-Забор товара у поставщика (закупки)

18-Забор БОЛЬШОЙ товара у поставщика  (закупки)

19-Доставка с оплатой картой

924 – Обмен товара

test

Тестовый режим использования API сервиса. Включается установкой значения параметра “yes”.

При работе в тестовом режиме заказы на доставку не создаются.

seats

Количество мест

takewarehouse

Склад приёма заказа (Список получаем методом warehouse)

cargotype

Вид груза

barcode

Штрихкод (Правило формирования штрихкода для ваших заказов уточняйте у логиста)

sitename

Наименование сайта для вывода в маршрутный лист курьера. (необязательное для заполнения)

email

Адрес электронной почты

tc_office

УИД офиса транспортной компании (заполняется в случае если используется услуга 12 - Транспортная компания)

tc_typerecipient

1 - физ лицо

2 - юр лицо

(заполняется в случае если используется услуга 12 - Транспортная компания)

tc_postcode

Почтовый индекс получателя (заполняется в случае если используется услуга 12 - Транспортная компания)

tc_address

Адрес получателя (заполняется в случае если используется услуга 12 - Транспортная компания)

tc_fullname

ФИО получателя (заполняется в случае если используется услуга 12 - Транспортная компания и вид получателя физлицо )

tc_phone

Телефон получателя (заполняется в случае если используется услуга 12 - Транспортная компания)

tc_passport

Паспортные данные получателя (заполняется в случае если используется услуга 12 - Транспортная компания и вид получателя физлицо )

tc_organization

Организация (заполняется в случае если используется услуга 12 - Транспортная компания и вид получателя юрлицо)

tc_INN

ИНН организации (заполняется в случае если используется услуга 12 - Транспортная компания и вид получателя юрлицо)

tc_KPP

КПП организации (заполняется в случае если используется услуга 12 - Транспортная компания и вид получателя юрлицо)

good

Перечень товаров, которые находятся в заказе. Для каждого товара заполняется:

good.article

Артикул товара

good.name

Наименование товара

good.cost

Стоимость товара

good.amount

Количество товара

Описание содержания тегов xml-ответа

Тег

Описание

Error

Текст ошибки добавления заказа

Описание ошибок        

Ошибка

Описание

Client not found

По API ключу не был сопоставлен клиент.

The service code is not found

Указан некорректный код услуги доставки

Order with the number already exists

Заказ с номером, который передавался параметром number, уже существует.

Error writing

Ошибка при записи заказа.

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>newordercourier</Method>

        <Orders>

                <Order

                        number = "000006120"

                        address = "Москва,Арбат1"

                        comment = "Комментарий"

                        shippingtimefrom = "08:00"

                        shippingtimefor = "18:00"

                        shippingdate = "01102012"

                        buyer = "Иванов Иван Иванович"

                        summa = "850.20"

                        assessedsumma = "850.20"

                        phone1 = "+380937776655"

                        phone2 = "+380938887766"

                        service = "1"

                        seats = "3"

takewarehouse = "Москва"

                        cargotype = "Автотовары"

                           email = "test@gmail.com">

<good

                                article = "A1"

                                name = "Товар 1"

                                cost = "850.20"

                                amount = "1"/>

                </Order>

        </Orders>

</File>        

Пример отправки заказа с услугой доставки заказа в офис транспортной компании

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>newordercourier</Method>

        <Orders>

                <Order

                        number = "test-tk-1"

                        address = "Москва,Арбат1"

                        comment = "Комментарий"

                        shippingtimefrom = "08:00"

                        shippingtimefor = "18:00"

                        shippingdate = "10122015"

                        buyer = "Иванов Иван Иванович"

                        summa = "850.20"

                        assessedsumma = "850.20"

                        phone1 = "80937776655"

                        phone2 = "80938887766"

                        service = "1"

                        seats = "3"

                        cargotype = "Автотовары"

                           email = "test@gmail.com"

takewarehouse = "Москва"

                        tc_office = "242a04e5-0656-11e3-b3a1-00155d030305"

                        tc_typerecipient = "1"

                        tc_postcode = "123456"

                        tc_address = "Адрес доставки"

                        tc_fullname = "ФИО получателя"

                        tc_phone = "80938887766"

                        tc_passport = "Паспотрные данные"

<good

                                article = "A1"

                                name = "Товар 1"

                                cost = "850.20"

                                amount = "1"/>

                />

        </Orders>

</File>        

 

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

<Orders>

        <Order>

                <number>000006120</number>

                <Status>Ok</Status>

        </Order>

</Orders>

Пример ответа с ошибкой создания заказа:

<Orders>

        <Order>

                <number>000006120</number>

                <Error>The service code is not found</Error>

        </Order>

</Orders>

  1. Добавление заказа Почта России

Метод: newordermail

Описание содержания тегов xml-запроса

Тег

Описание

number

Номер заказа в Вашей системе

comment

Комментарий по доставке (не обязательно)

shippingdate

Дата доставки. Задается в формате ddmmMMMM

cod

Наложенный платеж (yes / no)

summa

Сумма заказа

value

Ценность

buyer

ФИО Покупателя

phone

Номер телефона покупателя

zipcode

Индекс

region

Регион

district

Район

city

Город

address

Адрес

test

Тестовый режим использования API сервиса. Включается установкой значения параметра “yes”. При работе в тестовом режиме заказы на доставку не создаются.

takewarehouse

Склад приёма заказа (Список получаем методом warehouse)

cargotype

Вид груза

barcode

Штрих-код (Правило формирования штрих-кода для ваших заказов уточняйте у логиста)

sitename

Наименование сайта для вывода в маршрутный лист курьера. (необязательное для заполнения)

email

Адрес электронной почты

service

Код услуги доставки.

13 - Почтовая доставка

14 - Посылка онлайн (Почта РФ)

15 - Курьер онлайн (Почта РФ)

good

Перечень товаров, которые находятся в заказе. Для каждого товара заполняется:

good.article

Артикул товара

good.name

Наименование товара

good.cost

Стоимость товара

good.amount

Количество товара

Описание содержания тегов xml-ответа

Тег

Описание

Error

Текст ошибки добавления заказа

Описание ошибок        

Ошибка

Описание

Client not found

По API ключу не был сопоставлен клиент.

Order with the number already exists

Заказ с номером, который передавался параметром number, уже существует.

Error writing

Ошибка при записи заказа.

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>newordermail</Method>

        <Orders>

                <Order

                        number="apipost"

                        city="Екатеренбург"

                        address="ул. Ленина 1"

                        comment="Аккуратно"

                        shippingdate="01102014"

                        buyer="Иванов Иван Иванович"

                        cod="1000"

                        value="1000"

                        phone="+380937776655"

                        zipcode="620000"

                        region="Свердловская обл"

                        district="Екатеренбург"

                        cargotype = "Автотовары"

                        email = "test@gmail.com"

takewarehouse = "Москва"

service = "13"

<good

                                article = "A1"

                                name = "Товар 1"

                                cost = "1000"

                                amount = "1"/>

                />

        </Orders>

</File>        

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

<Orders>

        <Order>

                <number>apipost</number>

                <Status>Ok</Status>

        </Order>

</Orders>

Пример ответа с ошибкой создания заказа:

<Orders>

        <Order>

                <number>apipost</number>

                <Error>Client not found</Error>

        </Order>

</Orders>

  1. Добавление заказа Boxberry

Метод: neworderboxberry

Описание содержания тегов xml-запроса

Тег

Описание

number

Номер заказа в Вашей системе

comment

Комментарий по доставке (не обязательно)

phone1

Номер телефона1 покупателя

phone2

Номер телефона2 покупателя (не обязательно)

buyer

ФИО Покупателя

summa

Сумма заказа

assessedsumma

Оценочная стоимость заказа

weight

Вес заказа (в граммах)

pickup

ID пункта самовывоза (заполняется в случае доставки заказа через пункт самовывоза). Получить ID можно методом boxberryselfpickup.

postcode

ID индекса города доставки (заполняется в случае доставки заказа курьером). Получить ID можно методом boxberrypostcode. 

address

Адрес доставки (заполняется в случае доставки заказа курьером)

costdelivery

Стоимость доставки для покупателя

seats

Количество мест

cargotype

Вид груза

barcode

Штрих-код (Правило формирования штрих-кода для ваших заказов уточняйте у логиста)

sitename

Наименование сайта для вывода в маршрутный лист курьера. (необязательное для заполнения)

takewarehouse

Склад приёма заказа (Список получаем методом warehouse)

test

Тестовый режим использования API сервиса. Включается установкой значения параметра “yes”. При работе в тестовом режиме заказы на доставку не создаются.

good

Перечень товаров, которые находятся в заказе. Для каждого товара заполняется:

good.article

Артикул товара

good.name

Наименование товара

good.cost

Стоимость товара

good.vat

НДС на товар

good.amount

Количество товара

email

Адрес электронной почты

Описание содержания тегов xml-ответа

Тег

Описание

Error

Текст ошибки добавления заказа

Описание ошибок        

Ошибка

Описание

Client not found

По API ключу не был сопоставлен клиент.

Order with the number already exists

Заказ с номером, который передавался параметром number, уже существует.

Pickup not found

Не найден пункт самовывоза по переданному ID

Postcode not found

Не найден индекс города по переданному ID

Assed summa = 0

Оценочная стоимость заказа равна нулю.

Assed summa > 100000

Оценочная стоимость больше 100 000 рублей

Error writing

Ошибка при записи заказа.

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>neworderboxberry</Method>

        <Orders>

                <Order

                        number = "test-0002"

                        comment = "Комментарий"

                        phone1 = "0123456789"

                        phone2 = "9876543210"

                        buyer = "Иванов Иван Иванович"

                        summa = "10000"

                        assessedsumma = "10000"

                        weight = "600"

                        pickup = "74682f0b-117f-11e4-a9f5-00155d030401"

                        postcode = ""

                        address = "Ярославль, Ленина д.1 кв 10"

                        costdelivery = "300"

                        seats = "2"

                        cargotype = "Игрушки"                        

                        takewarehouse = "Москва"

email = "test@gmail.com">

                        <good

                                article = "A1"

                                name = "Товар 1"

                                cost = "1000"

                                vat = "20"

                                amount = "4"/>

                        <good

                                article = "A2"

                                name = "Товар 2"

                                cost = "2000"

                                vat = "20"

                                amount = "3"/>

                </Order>

</Orders>

</File>

        

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

<Orders>

        <Order>

                <number>apipost</number>

                <Status>Ok</Status>

        </Order>

</Orders>

Пример ответа с ошибкой создания заказа:

<Orders>

        <Order>

                <number>apipost</number>

                <Error>Client not found</Error>

        </Order>

</Orders>

  1. Добавление заказа Hermes        

Метод: neworderhermes

Описание содержания тегов xml-запроса

Тег

Описание

number

Номер заказа в Вашей системе

comment

Комментарий по доставке (не обязательно)

phone1

Номер телефона1 покупателя

buyer

ФИО Покупателя

summa

Сумма заказа

assessedsumma

Оценочная стоимость заказа

weight

Вес заказа (в граммах)

pickup

ID пункта самовывоза (заполняется в случае доставки заказа через пункт самовывоза). Получить ID можно методом hermesselfpickup.

seats

Количество мест

cargotype

Вид груза

barcode

Штрих-код (Правило формирования штрих-кода для ваших заказов уточняйте у логиста)

sitename

Наименование сайта для вывода в маршрутный лист курьера. (необязательное для заполнения)

takewarehouse

Склад приёма заказа (Список получаем методом warehouse)

test

Тестовый режим использования API сервиса. Включается установкой значения параметра “yes”. При работе в тестовом режиме заказы на доставку не создаются.

email

Адрес электронной почты

good

Перечень товаров, которые находятся в заказе. Для каждого товара заполняется:

good.article

Артикул товара

good.name

Наименование товара

good.cost

Стоимость товара

good.amount

Количество товара

Описание содержания тегов xml-ответа

Тег

Описание

Error

Текст ошибки добавления заказа

Описание ошибок        

Ошибка

Описание

Client not found

По API ключу не был сопоставлен клиент.

Order with the number already exists

Заказ с номером, который передавался параметром number, уже существует.

Pickup not found

Не найден пункт самовывоза по переданному ID

Error writing

Ошибка при записи заказа.

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>neworderhermes</Method>

        <Orders>

                <Order

                        number = "testhermes-0002"

                        comment = "Комментарий"

                        phone1 = "0123456789"

                        phone2 = "9876543210"

                        buyer = "Иванов Иван Иванович"

                        summa = "10000"

                        assessedsumma = "10000"

                        weight = "600"

                        pickup = "85c1820b-bccb-11e4-b950-00155d030231"

                        seats = "2"

                        cargotype = "Игрушки"                        

                        takewarehouse = "Москва"

email = "test@gmail.com"

<good

                                article = "A1"

                                name = "Товар 1"

                                cost = "10000"

                                amount = "1"/>

                />

</Orders>

</File>

        

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

<Orders>

        <Order>

                <number>testhermes-0002</number>

                <Status>Ok</Status>

        </Order>

</Orders>

Пример ответа с ошибкой создания заказа:

<Orders>

        <Order>

                <number>testhermes-0002</number>

                <Error>Client not found</Error>

        </Order>

</Orders>

  1. Добавление заказа партнерских пунктов        

Метод: neworderpartner

Описание содержания тегов xml-запроса

Тег

Описание

number

Номер заказа в Вашей системе

comment

Комментарий по доставке (не обязательно)

phone1

Номер телефона1 покупателя

buyer

ФИО Покупателя

summa

Сумма заказа

assessedsumma

Оценочная стоимость заказа

weight

Вес заказа (в граммах)

pickup

ID партнерского пункта. Получить ID можно методом partnerselfpickup.

seats

Количество мест

cargotype

Вид груза

barcode

Штрих-код (Правило формирования штрих-кода для ваших заказов уточняйте у логиста)

sitename

Наименование сайта для вывода в маршрутный лист курьера. (необязательное для заполнения)

takewarehouse

Склад приёма заказа (Список получаем методом warehouse)

test

Тестовый режим использования API сервиса. Включается установкой значения параметра “yes”. При работе в тестовом режиме заказы на доставку не создаются.

email

Адрес электронной почты

good

Перечень товаров, которые находятся в заказе. Для каждого товара заполняется:

good.article

Артикул товара

good.name

Наименование товара

good.cost

Стоимость товара

good.amount

Количество товара

Описание содержания тегов xml-ответа

Тег

Описание

Error

Текст ошибки добавления заказа

Описание ошибок        

Ошибка

Описание

Client not found

По API ключу не был сопоставлен клиент.

Order with the number already exists

Заказ с номером, который передавался параметром number, уже существует.

Pickup not found

Не найден партнерский пункт по переданному ID

Error writing

Ошибка при записи заказа.

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>neworderpartner</Method>

        <Orders>

                <Order

                        number = "testpartner-0001"

                        comment = "Комментарий1111"

                        phone1 = "0123456789"

                        phone2 = "9876543210"

                        buyer = "Иванов Иван Иванович"

                        summa = "10000"

                        assessedsumma = "10000"

                        weight = "600"

                        pickup = "8a5e6512-02a1-11e8-a47f-0050569b6f79"

                        seats = "2"

                        cargotype = "Игрушки"                        

                        takewarehouse = "Москва"

                email = "test@gmail.com">

<good

                                article = "A1"

                                name = "Товар 1"

                                cost = "10000"

                                amount = "1"/>

                </Order>

</Orders>

</File>

        

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

<Orders>

        <Order>

                <number>testpartner-0001</number>

                <Status>Ok</Status>

        </Order>

</Orders>

Пример ответа с ошибкой создания заказа:

<Orders>

        <Order>

                <number>testpartner-0001</number>

                <Error>Client not found</Error>

        </Order>

</Orders>

  1. Создание заявки на забор товара

Метод: RequestForIntake

Описание содержания тегов xml-запроса

Тег

Описание

IdRegion

Уникальный идентификатор региона в котором происходит забор товара. Список регионов можно получить методом DeliveryRegion

Time

Время забора. Варианты:

“15-17”

“16-18”

“17-19”

“18-20”

“19-21”

Volume

Объем заказов. Варианты:

“До 0.3 м3”

“До 0.6 м3”

“Более 0.7 м3”

Описание содержания тегов xml-ответа

Тег

Описание

Error

Текст ошибки добавления заявки на забор заказов

Описание ошибок        

Ошибка

Описание

Region not found

Регион забора не найден. Надо проверить уникальный идентификатор, который передается в параметрах.

Time not found

Время забора не найдено.

Volume not found

Объём заказов не найден.

Ошибка статуса клиента. Пожалуйста свяжитесь с менеджером

У клиента статус в базе не активный и он не может создавать заборы. Надо связаться с менеджером службы доставки и поменять статус клиента.

Requests for intake can be left to...

Заявки на забор могут добавляться до определённого времени. Если вы пропустили это время — свяжитесь с менеджером службы доставки.

Забор для региона ХХХХ уже сформирован. Параметры: ХХХХХ

Забор уже присутствует в базе. В сообщении вы увидите параметры забора. Если данные неправильные — свяжитесь с менеджером службы доставки.

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>RequestForIntake</Method>

        <IdRegion>e92ae8a2-074c-11e2-a6e5-00152d030203</IdRegion>

        <Time>с 16 до 17</Time>

        <Volume>0.7 м3</Volume>

</File>

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

<Status>Ok</Status>

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

<Errors>

<Error>

Забор для региона Москва уже сформирован. Параметры: Время: с 16 до 17 обычная машина Комментарий: Габарит: 0.7 м3. Загружено через АПИ Для изменения параметров свяжитесь с логистами

</Error>

</Errors>

  1. Печатные формы

  1. Печать акта приема-передачи

Метод: printactofreceiving.

Результатом выполнения метода будет pdf-файл с печатной формой акта приема-передачи.

Описание содержания тегов xml-запроса

Тег

Описание

IdContract

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

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

ContractNumber

Наименование договора, который будет выводится в печатной форме. Не обязательно для заполнения. Игнорируется в случае заполненного IdContract

ContractData

Дата договора, которая будет выводится в печатной форме. Не обязательна для заполнения. Игнорируется в случае заполненного IdContract

CustomerPosition

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

CustomerName

ФИО ответственного лица клиента. Будет выводится в печатной форме. Не обязательно для заполнения. Игнорируется в случае заполненного IdContract

Organization

Наименование организации. Будет выводится в печатной форме. Не обязательно для заполнения. Игнорируется в случае заполненного IdContract

City

Город составления акта. Будет выводится в печатной форме. Не обязательно для заполнения. Игнорируется в случае заполненного IdContract

number

Номер заказа, который передаётся

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>printactofreceiving</Method>

<IdContract>cc5e90a7-2f4f-11e4-89ef-00155d030231</IdContract>

        <Orders>

                <Order number = "номер1" seats = "1"/>

                <Order number = "номер2" seats = "1"/>

                <Order number = "номер3" seats = "2"/>

                <Order number = "номер4" seats = "1"/>

        </Orders>

</File>

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

  1. Печать маркировок

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

http://api.grastin.ru/print.php?api=АПИ-ключ&number=Номер заказа1||

Номер заказа2||Номер заказа3

Например:

http://api.grastin.ru/print.php?api=024840a2-8800-474a-bd75-39407b93cd90&number=1691||1692||1693

Используя методы АПИ вы можете получить все данные для печати маркировок средствами своей системы управления заказами. Расшифровка значений на маркировке приведена на рисунке.

Marker.png

  1. Печать маркировки через xml-запрос

Метод: printmark.

Результатом выполнения метода будет pdf-файл с печатной формой маркировок заказов.

Описание содержания тегов xml-запроса

Тег

Описание

number

Номер заказа, для которого надо напечатать маркировку.

onepersheet

Печать этикетки на одном листе. По умолчанию равно “false”. Параметр не обязательный для заполнения

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

<File>

        <API>024840a2-8800-474a-bd75-39407b93cd90</API>

        <Method>printmark</Method>

<onepersheet>false</onepersheet>

        <Orders>

                <Order number = "КЮС540-1"/>

                <Order number = "КЮС540-2"/>

                <Order number = "КЮС540-3"/>

                <Order number = "КЮС540-4"/>

        </Orders>

</File>

Пример ответа: 2017-05-15_112948.png

  1. Тексты ошибок

Текст ошибки

Описание

Good name can not be empty  

Наименование товара не может быть пустым

Good amount can not be empty  

Количество товаров должно быть заполнено

Good cost can not be empty  

Цена товара должна быть заполнена

Client not found

Не удалось установить клиента по api-ключу

limit is 10000 requests

Клиент достиг суточный лимит в 10 000 обращений к API

Customers forbidden to add orders

Клиенту запрещено добавление заказов через API

Number not found

Не найден номер заказа

The service code is not found

Не найден код услуги

The tc_office is not found

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

Invalid tc_office uid

Неправильный ID офиса транспортной компании

The tc_typerecipient is not found

Не найден вид получателя транспортной компании

The tc_typerecipient is not valid

Вид получателя транспортной компании неправильный

The tc_postcode is not found

Индекс транспортной компании не найден

The tc_postcode must consist only of digits

Индекс транспортной компании неправильный. Он должен содержать только цифры

The tc_address is not found

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

The tc_phone is not found

Не найден номер телефона транспортной компании

The tc_fullname is not found

Не найдено ФИО получателя транспортной компании

The tc_passport is not found

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

The tc_organization is not found

Не найдена организация транспортной компании

The tc_INN is not found

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

The tc_KPP is not found

Не найден КПП транспортной компании

Order with the number already exists. Change adress deny         

Заказ с таким номером уже существует. Изменение адреса запрещено

Order with the number already exists. Change service deny         

Заказ с таким номером уже существует. Изменение услуги запрещено.

Order with the number already exists. Change sets deny         

Заказ с таким номером уже существует. Изменение количество мест запрещено.

Order with the number already exists. Change order deny

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

Error in shippingdate

Ошибка в дате доставки

Error in phone1. Phone number must contain 11 digits

Ошибка в номере телефона

Error. Seats must be less than 100

Количество мест должно быть меньше 100

The summa amount shall be equal to the sum of goods

Сумма заказа должна быть равна сумме товаров

Error in vat

Ошибка в НДС

Error in amountvat

Ошибка в сумме НДС

Error change order

Ошибка изменения заказа.

Error writing

Ошибка записи заказа.

Invalid idregion uid

Ошибка ИД региона доставки.

Delivery region not found

Не найден регион доставки.

Contract for the delivery region not found

Не найден договор для региона доставки.

Pickup or postcode not found/ Please check idpickup or idpostcode

Не найден пункт самовывоза. Необходимо проверить значения, которые передаются в idpickup,idpostcode

Could not calculate shipping cost

Невозможно расчитать стоимость доставки.

City from not found

В запросе не обнаружен город, из которого будет осуществляться доставка.

Contract client not found

Не найден договор клиента.

weight not found

Не найден вес в запросе.

Error reading XML

Ошибка чтения xml-запроса.

API not found in xml

Не найден api-ключ в запросе.

Method not found in xml

Не найден метод в xml

Status not found in xml

Не найден статус в xml

Status unknown

Невозможно определить статус заказа.

Invalid contract uid

Ошибочный ИД договора клиента.

Contract not found

Договор не найден.

Contract is not contract of your client

Не найден договор для клиента.

Contract  is not active

Договор не активный.

Error in datedeliverystart

Ошибка в периоде даты отгрузки

Error in datedeliveryend

Ошибка в периоде даты отгрузки

Error in latitude

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

Error in longitude

Ошибка в долготе

Orders not found in xml

Не найден список заказов в xml-запросе

Error in datestart

Ошибка в периоде отчета агента

Error in dateend

Ошибка в периоде отчета агента

Datestart not set

Ошибка в периоде отчета агента

Dateend not set

Ошибка в периоде отчета агента

The main contract does not exist

У клиента не определён основной договор

Customers forbidden to add requests for intake

Клиенту запрещено добавлять заявку на забор.

Region not found

Не найден регион

Time not found

Не найдено время

Volume not found

Не найден габарит

Requests for intake can be left to ХХХ

Добавление заявок на забор разрешено до ХХХ

Pickup or Postcode must be filled

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

Seats must be equal to 1

Количество мест должно быть равно 1

Invalid Pickup uid

Неправильный ИД пункта самовывоза

Pickup with full prepayment. Order amount must be equal zero

Пункт самовывоза с полной предоплатой. Сумма заказа должна быть равна 0

Invalid Postcode uid

Неправильный ИД индекса

Postcode not found

Индекс не найден

Assed summa = 0

Оценочная стоимость = 0

Assed summa > 100000

Оценочная стоимость > 100000

Assessedsumma can not be less summa

Оценочная стоимость не может быть меньше суммы заказа

The estimated amount shall be equal to the sum of goods and shipping costs

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

The summa amount shall be equal to the sum of goods

Сумма заказа должна быть равна сумме товаров.

  1. Пример подключения

  1. Пример подключения к API используя PHP

<?php

        $xml = "<File> <API>024840a2-8800-474a-bd75-39407b93cd90</API> <Method>orderinformation</Method></File>";

        $url = 'http://api.grastin.ru/api.php';

        $ch = curl_init();

        curl_setopt($ch,CURLOPT_URL, $url);

        curl_setopt($ch,CURLOPT_POST, 1);

        curl_setopt($ch,CURLOPT_POSTFIELDS, 'XMLPackage='.urlencode($xml));

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

        curl_setopt($ch, CURLOPT_HEADER, 0);

        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);

        $result = curl_exec($ch);

        curl_close($ch);

?>

  1. Пример подключения к API из 1С

Скачать обработку-пример можно тут: http://danila.org.ua/api-grastin/

add_order.png

Данная обработка позволяет:

  1. Техподдержка

При возникновении вопросов по работе с API просьба обращаться в техподдержку по адресу helpdesk@grastin.ru

Во время обращения просьба указать:

  1. Код клиента или API-ключ;
  2. Текст проблемного запроса.

Предоставление этой информации ускорит рассмотрение ошибки.

  1. Политика создания сторонних приложений интеграции.

При публикации приложений, взаимодействующих с api Грастин, обязательным условием является указание слова неофициальный(ая) в названии приложения.