API — различия между версиями

Материал из Меасофт
Перейти к: навигация, поиск
м (Запрос статуса)
м (Оформление заказа)
Строка 28: Строка 28:
 
   </receiver>
 
   </receiver>
 
   <weight>5.1</weight>
 
   <weight>5.1</weight>
   <quantity>23</quantity>
+
   <quantity>2</quantity>
 
   <paytype>CASH</paytype>
 
   <paytype>CASH</paytype>
 
   <price>387.5</price>
 
   <price>387.5</price>
Строка 42: Строка 42:
 
</neworder>
 
</neworder>
 
</source>
 
</source>
 +
 +
Описание полей:
 +
 +
'''orderno''' - Номер заказа. Если присваивается клиентом - указывается здесь. Если не присваивается - можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе.
 +
 +
'''barcode''' - Штрих-код заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-код. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде символов подчеркивания, говорящие о
 +
 +
'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
 +
{|
 +
|CASH
 +
|Наличными (по-умолчанию)
 +
|-
 +
|CARD
 +
|Картой
 +
|-
 +
|NO
 +
|Без оплаты
 +
|}
  
 
== Запрос статуса ==
 
== Запрос статуса ==

Версия 12:22, 14 апреля 2014

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


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

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


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

<?xml version="1.0" encoding="UTF-8"?>
<neworder>
 <auth login="login" pass="pass"></auth>
 <order orderno="111111">
   <barcode>111111</barcode>
   <receiver>
     <company>МВД</company>
     <person>САМАРИТЯНИН</person>
     <phone>123-45-67</phone>
     <town>Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
   </receiver>
   <weight>5.1</weight>
   <quantity>2</quantity>
   <paytype>CASH</paytype>
   <price>387.5</price>
   <inshprice>387.5</inshprice>
   <enclosure>Детские игрушки</enclosure>
   <instruction>Проверить при покупателе, подписать акт</instruction>
   <items>
      <item quantity="1" mass="0.2" retprice="37.5" barcode="2345625213125" article="1">Мяч</item>
      <item quantity="2" mass="2" retprice="100" barcode="4645625213138" article="2">Обруч</item>
      <item quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
   </items>
 </order>
</neworder>

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

orderno - Номер заказа. Если присваивается клиентом - указывается здесь. Если не присваивается - можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе.

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

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

CASH Наличными (по-умолчанию)
CARD Картой
NO Без оплаты

Запрос статуса

<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
 <auth login="login" pass="pass"></auth>
 <orderno></orderno>
 <datefrom>2014-04-03</datefrom>
 <dateto>2014-04-03</dateto>
 <done>ONLY_NOT_DONE</done>
</statusreq>