Изменения

Перейти к: навигация, поиск

API Documentation

1215 байт добавлено, 11:55, 16 апреля 2021
м
→‎CMS integrations
If you still have questions after reading the given documentation, feel free to ask them via e-mail [mailto:support@courierexe.ru support@courierexe.ru]. In your e-mail message you should introduce yourself, leave your contact information (your phone number, Skype login) and the name of the company that you want to integrate with.
== Complete integrations CMS Integrations ==
You can download integration the following modules to integrate with popular CMS:
{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color: black#ffffff; borederborder: 1px solid #999999;" cellpadding="10" cellspacing="0"!style="width: 35%;"| Content Management System (CMS)!style="width: 15%;"|Module version !style="width: 15%;"|LinkDownload!style="width: 35%;"|NoteComment
|-
|[[FileФайл:bitrix.png|center|x44px]]|style="text-align: center;"|1.5.8 от 13.11.2017|style="text-align: center;"|[http://courierexemarketplace.ru/download/api/1c-bitrix.zip Download Unicode]<br>[http:ru/solutions/courierexemeasoft.ru/download/apicourier/bitrix_ansi.zip Download ANSIInstall]|Supports version 14.5 and newer oneshigher.
|-
|[[FileФайл:prestashop.png|center|x44pxx60px]]|style="text-align: center;"|1.4.2 dated from September 6, 2017
|style="text-align: center;"|[http://courierexe.ru/download/api/prestashop.zip Download]
|Supports version 1.5.2.0 and newer ones higher (including 2.x!)
|-
|[[File:opencart.png|center|x44px]] [[Файл:ocstoreOpencartOCStore.png|center|x30pxx60px]]|style="text-align: center;"|[http://courierexe.ru/download/api/opencart.zip For version 1.75.5.1]<br>[http://courierexe.ru/download/api/measoft_oc2.ocmod.zip For version 2 от 06.090]<br>[http://courierexe.2017|style="text-align: center;"|ru/download/api/measoft_oc2.3.ocmod.zip For version 2.3]<br>[http://courierexe.ru/download/api/opencartmeasoft_ос3.ocmod.zip DownloadFor version 3.0]| Supports versions from version 1.5.5.1 till 2and higher.2<br>Select a module for your OpenCart version.<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ ThirdAlternative third-party alternative module]
|-
|[[FileФайл:webasyst-shopscript.png|center|x44px]]|style="text-align: center;"|1[http://www.3webasyst.2 от 15ru/store/plugin/shop/measoftcourier/ Install module]<br>[https://www.08webasyst.2017ru/store/plugin/shipping/measoftcourier/ Install plugin]|The module is designed for sending orders to delivery service, while the plugin calculates delivery cost on creating an order.|-|[[Файл:advantshop.png|center|x44px]]|style="text-align: center;"|[httphttps://www.webasystpromo-z.ru/store/plugin/shop/measoftcourier/ InstallPROMO company site]|The PROMO company has developed the module. Contact PROMO to set up integration between MeaSoft and ADVANTSHOP.
|-
|[[FileФайл:insales.png|center|x44pxx80px]]|style="text-align: center;"|1.2.1 от 06.09.2017Configure using MeaSoft [[Личный кабинет клиента|style="text-align: center;"|[http://www.insales.ru/collection/all/product/kurierskaya-sluzhba-2008 Installpersonal account]]|[[Integration_with_other_systemsИнтеграция с другими системами#InsalesInSales|is set upGuide]] in user area in the system
|-
|[[FileФайл:Leadvertex.png|center|x44px]]|style="text-align: center;"|1.0 dated from November 15, 2016
|style="text-align: center;"|[[Файл:Leadvertex-howto.png|center|x44px]]
|[http://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft/ is set upConfigure] in user area in the system using [https://Leadvertex.ru Leadvertex]account
|-
|[[FileФайл:Retailcrm.png|center|x44pxx30px]]|style="text-align: center;"|1.0 dated from January 1, 2018
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[Integration_with_other_systemshttp://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRMConfigure] using MeaSoft [[Личный кабинет клиента|personal account]]|-|[[Файл:1C.jpg|center|x44px]]|style="text-align: center;"|-|[https://infostart.ru/public/692790/ Alternative third-party module]|-|[[Файл:Joomla2.jpg|center|x60px]]|style="text-align: center;"|[http://courierexe.ru/download/api/com_measoft.zip Download]|Integration with Virtuemart is set upavailable only.|-|[[Файл:Amocrm.png|center|x44px]] in user area in the system|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Download]||-|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Integrate with MeaSoft]||-|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Alternative third-party module]|Alternative third-party module|-|[[Файл:wordpress.jpg|center|x80px]]|style="text-align: center;"|[http://courierexe.ru/download/api/wordpress.zip Download]||-|[[Файл:Cscart.png|center|x60px]]|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Download]|Supports versions 4.10 and higher.
|-
|}
 The given modules are shared for free without any guarantee on the part of the developer. Their availability should be considered not as a means of complete automation of your interaction with the delivery service but more as an aid for online shop developers in building integration with delivery services. However, we will appreciate if you inform us about your needs and/or discrepancies found in our modules – this allows us to consider your demands when developing new versions of our modules.
== Test account ==
Due to [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 the peculiarities of XML extensible markup language], some symbols in the text should be replaced: & from &amp;amp; < to &amp;lt; > from &amp;gt; " to &amp;quot;
== Limitations Fair Usage Policy ==With the aim of protecting To protect our service from its improper use query limitation equal to and DDoS attacks, we have defined fair usage levels: * 30 tracking queries from a single IP address per 1 minute (use <code>statusreq</code>).* 150 queries from a single IP address per 1 minute.* 1500 queries from one a single IP-address for per 20-minute period has been introduced since May 29, 2017minutes.* 3000 queries from a single account per 1 hour.* 200 MB text data downloaded per 3 hours. In case the above-mentioned  If a limit is reachedexceeded, the IP-address will be is blocked; unblocking for up to 3 hours. Actions that result in blocking your IP address or account: * Attacking our API with status queries with numbers of all you orders. Mind that the IP-address is possible <code>tracking</code> queries are not intended for that, see [[API documentation#Order tracking by addressing number|description]]. These queries are especially bad at the technical support service with top of the subsequent discussion hour.* Sending queries like "Show statuses of your algorithms and their correctionall orders for the last 3 months" every 5 minutes.  Correct actions:
The best option for checking your orders` status is using "* To check order statuses, use <code>statusreq" </code> queries with parameter <code>changes=ONLY_LAST parameter</code>. You shouldn`t try to “attack” our API with queries containing numbers of all your orders* When requesting for changed statuses, especially, with "tracking" queries – they are not intended to be used for this (see their description)you must confirm that the statuses were sucessfully received by query <code>commitlaststatus</code>.
== Ordering ==
<town>Saint-Petersburg</town>
<address>Room 35, 38 Petrovka Str.</address>
<date>March 2014-03-22, 2014</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
*'''inshprice''' is a declared value.
*'''instruction''' is an instruction – a note.
*'''pvz''' is a pick-up point an order points of issue code. You can find out pick-up point the codes on request [[#The list of order points of issue|by the API requset]] or in user`s member area on “pvz” tab.
*'''department''' is the name of the department which the order is raised in.
*'''pickup''' is YES/NO attribute of pickup arrangement. If there is YES, then the entire order will be considered to be the assignment for cargo pickup but not for cargo delivery! It is applied for calling a courier to the receiver for the pickup of other packaging units.
:* '''''extcode''''' is an external code of a string. It is used for the identification of strings of orders when obtaining statuses. It is an optional field. IT IS NOT SUPPORTED YET.
In case it is necessary to specify them besides product units, additional services (for example, DELIVERY, order batching, lifting the order up to the floor, etc.) – they should be specified in the same “items” container as product units but without article numbers.
=== Examples of responses ===
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<quickstatus>NO</quickstatus>
</statusreq>
</source>
*'''changes''' can have only one value - ONLY_LAST. If this parameter is set, all other parameters, except quickstatus, will be ignored. The description of this mode is given here: [[#Newly changed statuses transfer|Newly changed statuses transfer]]
 
*'''quickstatus''' indicates the “depth” of transferred statuses: "YES" value (by default) - statuses are transferred starting from the information provided by a courier. Such statuses are quick (as a rule, they are provided by a courier immediately after delivery) but not always accurate. "NO" value prohibits status transfer according to oral information provided by the courier and provides only those statuses that have been entered by an operator manually, as a rule. It takes more time however the level of accuracy is much higher in this case. It is not recommended to combine (interleave) these two types of status transfer in case of newly changed statuses demand as in this case the system will consider that statuses of dispatches are changing.
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
* ''order'' container attributes:
:* '''''awb''''' is a courier company related waybill number.
:* '''''orderno2''''' is an order number from the urgent delivery subsystem.
:* '''''ordercode''''' is an internal code of the order in the system which is applied for some internal operations.
:* '''''givencode''''' is an internal code of the order in the system which is applied for some internal operations.
 
* '''''code''''' attribute of '''item''' container is an internal code of order string in the system which is applied for some internal operations.
:* '''''returns''''' is the amount of a certain product unit which a receiver has refused. It will have a non-zero value only in case of a partial refusal.
* '''''code''''' attribute of '''item''' container is an internal code of order string in the system which is applied for some internal operations.
* '''''coords''''' in '''receiver''' container indicates receiver position.
* '''currcoords''' indicates current order position. Its attributes are:
Источник — «https://wiki.courierexe.ru/index.php/Служебная:Сравнение_версий/9529...11912»

Навигация