Модуль доставки® API

Kazpost™ Developers / API сервиса получения адресного ярлыка

Сервис получения адресного ярлыка - Для Клиентов

Предоставляет base64 закодированный адресный ярлык и сгенерированный трэк номер.

WSDL боевого сервиса

http://rates.kazpost.kz/postratesprod/postratesws.wsdl Для получения адресного ярлыка необходимо отправить запрос на операцию GetAddrLetter указанный в WSDL модуля доставки.

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

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

Тело запроса операции GetAddrLetter:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pos="http://webservices.kazpost.kz/postratesws">
   <soapenv:Header/>
   <soapenv:Body>
      <pos:GetAddrLetterRequest>
         <pos:Key>?</pos:Key>
         <pos:AddrInfo>
            <!--Optional:-->
            <pos:RcpnIIN>?</pos:RcpnIIN>
            <!--Optional:-->
            <pos:RcpnName>?</pos:RcpnName>
            <pos:RcpnPhone>?</pos:RcpnPhone>
            <!--Optional:-->
            <pos:RcpnEmail>?</pos:RcpnEmail>
            <!--Optional:-->
            <pos:RcpnCountry>?</pos:RcpnCountry>
            <pos:RcpnIndex>?</pos:RcpnIndex>
            <!--Optional:-->
            <pos:RcpnCity>?</pos:RcpnCity>
            <!--Optional:-->
            <pos:RcpnDistrict>?</pos:RcpnDistrict>
            <pos:RcpnStreet>?</pos:RcpnStreet>
            <pos:RcpnHouse>?</pos:RcpnHouse>
            <!--Optional:-->
            <pos:SndrBIN>?</pos:SndrBIN>
            <!--Optional:-->
            <pos:SndrName>?</pos:SndrName>
            <!--Optional:-->
            <pos:SndrPhone>?</pos:SndrPhone>
            <!--Optional:-->
            <pos:SndrEmail>?</pos:SndrEmail>
            <!--Optional:-->
            <pos:SndrCountry>?</pos:SndrCountry>
            <pos:SndrIndex>?</pos:SndrIndex>
            <!--Optional:-->
            <pos:SndrCity>?</pos:SndrCity>
            <!--Optional:-->
            <pos:SndrDistrict>?</pos:SndrDistrict>
            <!--Optional:-->
            <pos:SndrStreet>?</pos:SndrStreet>
            <!--Optional:-->
            <pos:SndrHouse>?</pos:SndrHouse>
            <!--Optional:-->
            <pos:Weight>?</pos:Weight>
            <!--Optional:-->
            <pos:DeclaredValue>?</pos:DeclaredValue>
            <!--Optional:-->
            <pos:CashOnDelivery>?</pos:CashOnDelivery>
            <!--Optional:-->
            <pos:DeliverySum>?</pos:DeliverySum>
            <pos:ProductCode>?</pos:ProductCode>
            <pos:Marks>
               <!--Zero or more repetitions:-->
               <pos:Mark>?</pos:Mark>
            </pos:Marks>
            <!--Optional:-->
            <pos:AddInfo>
               <!--0 to 5 repetitions:-->
               <pos:Field>?</pos:Field>
            </pos:AddInfo>
            <!--Optional:-->
            <pos:OrderNumber>?</pos:OrderNumber>
            <!--Optional:-->
            <pos:PartNum>?</pos:PartNum>
            <!--Optional:-->
            <pos:EnvelopeSize>?</pos:EnvelopeSize>
            <pos:SendMethod>?</pos:SendMethod>
            <pos:MailCtg>?</pos:MailCtg>
            <!--Optional:-->
            <pos:Barcode>?</pos:Barcode>
            <!--Optional:-->
            <pos:OrderNum>?</pos:OrderNum>
            <!--Optional:-->
            <pos:MailCount>?</pos:MailCount>
            <!--Optional:-->
            <pos:Pickup>?</pos:Pickup>
            <!--Optional:-->
            <pos:NPI>?</pos:NPI>
            <!--Optional:-->
            <pos:DEA_NUMBER>?</pos:DEA_NUMBER>
            <!--Optional:-->
            <pos:DEA_DEPCODE>?</pos:DEA_DEPCODE>
            <!--Optional:-->
            <pos:PAY_CODE>?</pos:PAY_CODE>
            <!--Optional:-->
            <pos:Status>?</pos:Status>
            <!--Optional:-->
            <pos:Key>?</pos:Key>
            <!--Optional:-->
            <pos:F1>?</pos:F1>
            <!--Optional:-->
            <pos:F2>?</pos:F2>
            <!--Optional:-->
            <pos:F3>?</pos:F3>
            <!--Optional:-->
            <pos:F4>?</pos:F4>
            <!--Optional:-->
            <pos:F5>?</pos:F5>
            <!--Optional:-->
            <pos:F6>?</pos:F6>
            <!--Optional:-->
            <pos:F7>?</pos:F7>
            <!--Optional:-->
            <pos:F8>?</pos:F8>
            <!--Optional:-->
            <pos:F9>?</pos:F9>
            <!--Optional:-->
            <pos:F10>?</pos:F10>
            <!--Optional:-->
            <pos:F11>?</pos:F11>
            <!--Optional:-->
            <pos:F12>?</pos:F12>
            <!--Optional:-->
            <pos:F13>?</pos:F13>
            <!--Optional:-->
            <pos:F14>?</pos:F14>
            <!--Optional:-->
            <pos:F15>?</pos:F15>
         </pos:AddrInfo>
      </pos:GetAddrLetterRequest>
   </soapenv:Body>
</soapenv:Envelope>

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

Key - Идентификационный ключ клиента (32 символов) (Необходимо зарегистрироваться в post.kz и зайти в Профиль для регистрации организации)

RcpnIIN - ИИН получателя (12 цифр, не обязательный)

RcpnName - ФИО получателя (256 символов)

RcpnPhone - Номер телефона получателя 7ХХХХХХХХХ (10 цифр)

RcpnEmail - Email получателя (при наличии, login@example.com, не обязательный)

RcpnCountry - Страна получателя (256 символов)

RcpnIndex - Почтовый индекс получателя (6 цифр)

https://api.post.kz/#byAddress

RcpnCity - Город получателя (256 символов)

RcpnDistrict - Район получателя (256 символов, не обязательный)

RcpnStreet - Улица получателя (256 символов)

RcpnHouse - Дом/квартира получателя (10 символов)

SndrBIN - БИН отправителя (12 цифр)

примечание: Для нерезидентов РК передавать 12 нулей(000000000000)

SndrName - Название компании/ ФИО отправителя (256 символов)

SndrPhone - Номер телефона отправителя 7ХХХХХХХХХ (10 цифр)

SndrEmail - Email отправителя (при наличии, login@example.com, не обязательный)

SndrCountry - Страна отправителя (256 символов, не обязательный)

SndrIndex - Почтовый индекс отправителя (6 цифр)

https://api.post.kz/#byAddress

SndrCity - Город отправителя (256 символов)

SndrDistrict - Район отправителя (256 символов, не обязательный)

SndrStreet - Улица отправителя (256 символов)

SndrHouse - Дом/квартира отправителя (10 символов)

Weight - Вес (кг, 4 цифры)

DeclaredValue - Объявленная ценность (хххххх.хх 8 цифр, не обязательный)

примечание: если MailCtg = 2 или 4 , то обязательный

CashOnDelivery - Наложенный платеж (хххххх.хх 8 цифр, не обязательный)

примечание: если MailCtg = 4, то обязательный

DeliverySum - Сумма за доставку (хххххх.хх 8 цифр, не обязательный)

ProductCode - Код продукта (4 символа, см. справочник)

Marks - Отметки (список отметок Mark, см. справочник)

AddInfo - Дополнительные поля для добавления в Адресный ярлык (не обязательный)

OrderNumber - Номер заказа интернет магазина(не обязательный)

PartNum - Номер партии (не обязательный)

EnvelopeSize - (“Габариты”), (S/M/L, не обязательный, см. справочник.

примечание:если Productcode=P109, то обязательный

SendMethod - Способ пересылки (1 символ, см. справочник)

MailCtg - Категория отправления (1 символ, см. справочник)

Barcode - Трэк номер (не обязательный)

OrderNum - Номер заказа интернет магазина(не обязательный)

MailCount - Количество генерируемых ШПИ (не обязательный)

Pickup - Плановая дата забора заказа. (не обязательный)

NIP - Новый почтовый индекс. (не обязательный)

DEA_NUMBER - Номер договора (255 символов, не обязательный)

DEA_DEPCODE - Номер подразделения договора (подразделение где создан договор) (255 символов, не обязательный)

PAY_CODE - (255 символов, не обязательный)

Status - (255 символов, не обязательный)

Key - (255 символов, не обязательный)

F1-F15 - Доп. параметры (в случае необходимости)

License - (не обязательный)

Certif - (не обязательный)

Invoice - (не обязательный)

Account - (не обязательный)

WeightAll - (не обязательный)

CostAll - (не обязательный)

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pos="http://webservices.kazpost.kz/postratesws">
<soapenv:Header/>
<soapenv:Body>
 <pos:GetAddrLetterRequest>
  <pos:Key>EMKWG7x5dSrCowxnKd1adBItLi0lcwkR</pos:Key>
  <pos:AddrInfo>
   <pos:RcpnIIN>123456789012</pos:RcpnIIN>
   <pos:RcpnName>ФИОполучателя</pos:RcpnName>
   <pos:RcpnPhone>77010000000</pos:RcpnPhone>
   <pos:RcpnEmail>test@test.com</pos:RcpnEmail>
   <pos:RcpnCountry> Казахстан </pos:RcpnCountry>
   <pos:RcpnIndex>010000</pos:RcpnIndex>
   <pos:RcpnCity>Город</pos:RcpnCity>
   <pos:RcpnDistrict>Район</pos:RcpnDistrict>
   <pos:RcpnStreet>Улица</pos:RcpnStreet>
   <pos:RcpnHouse>12</pos:RcpnHouse>
   <pos:SndrBIN>098765432121</pos:SndrBIN>
   <pos:SndrName>Компания</pos:SndrName>
   <pos:SndrPhone>77010000000</pos:SndrPhone>
   <pos:SndrEmail>company@company.com</pos:SndrEmail>
   <pos:SndrCountry>Казахстан</pos:SndrCountry>
   <pos:SndrIndex>050000</pos:SndrIndex>
   <pos:SndrCity>Город</pos:SndrCity>
   <pos:SndrDistrict>Район</pos:SndrDistrict>
   <pos:SndrStreet>Улица</pos:SndrStreet>
   <pos:SndrHouse>25</pos:SndrHouse>
   <pos:Weight>1.55</pos:Weight>
   <pos:DeclaredValue>15000</pos:DeclaredValue>
   <pos:CashOnDelivery>15000</pos:CashOnDelivery>
   <pos:ProductCode>P103</pos:ProductCode>
   <pos:Marks>
    <pos:Mark>returnAfter</pos:Mark>
   </pos:Marks>
   <pos:SendMethod>2</pos:SendMethod>
   <pos:MailCtg>4</pos:MailCtg>
                        <pos:OrderNum>123456789</pos:OrderNum>
                        <pos:MailCount>1</pos:MailCount>
                        <pos:DEA_NUMBER>537868654454000542</pos:DEA_NUMBER>
                        <pos:DEA_DEPCODE>279900</pos:DEA_DEPCODE>
  </pos:AddrInfo>
 </pos:GetAddrLetterRequest>
</soapenv:Body>
</soapenv:Envelope>

Ответ на запрос:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
   <ns2:GetAddrLetterResponse xmlns:ns2="http://webservices.kazpost.kz/postratesws">
      <ns2:AddrLetPdf>base64PDF</ns2:AddrLetPdf>
      <ns2:Barcode>AP000000001KZ</ns2:Barcode>
      <ns2:ResponseInfo>
         <ns2:ResponseGenTime>2015-08-28T01:22:07.243+06:00</ns2:ResponseGenTime>
         <ns2:ResponseCode>0</ns2:ResponseCode>
         <ns2:ResponseText>Принято успешно!</ns2:ResponseText>
      </ns2:ResponseInfo>
   </ns2:GetAddrLetterResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

если addrInfo.getOrderNum() != null или addrInfo.getBarcode() == null и в любом случаем если prodCode.equals("P203") то формируется AddrLetPdfs и Barcodes

AddrLetPdf - Base64 закодированный pdf адресного ярлыка формата А5

Barcode - Сгенерированный трэк номер

AddrLetPdfs - массив Base64 закодированных pdf адресного ярлыка формата А5

Barcodes - массив Сгенерированных трэк номеров

ResponseGenTime - Время сформированного ответа

ResponseCode - Код ответа

ResponseText - Текст ответа (успешно или ошибка)

_{Примечание* - Данный материал находится на стадии разработки}