Изменения

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 email message , please introduce yourself, leave your contact information (your phone number, Skype login) and the name of the company that you want to integrate with.

|style="text-align: center;"|[httphttps://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Install]

|style="text-align: center;"|[httphttps://courierexe.ru/download/api/prestashop.zip Download]

|style="text-align: center;"|[httphttps://courierexe.ru/download/api/opencart.zip For version 1.5.5.1]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.ocmod.zip For version 2.0]<br>[httphttps://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip For version 2.3]<br>[httphttps://courierexe.ru/download/api/measoft_ос3.ocmod.zip For version 3.0]

<!--|[[Файл:advantshop.png|center|x44px]]

|--->

|style="text-align: center;"|[httphttps://courierexe.ru/download/api/com_measoft.zip Download]

|style="text-align: center;"|[httphttps://courierexe.ru/download/api/wordpress.zip Download]

For debugging , you can access your test client account at

login testlogin password testmpass

To simplify the process of integration, you can download [httphttps://courierexe.ru/download/api/php_sample.zip the example of addressing the service using PHP].

Use the following credentialsYou can access your client account at: <source lang=xml><auth extra="8" login="login" pass="pass"></auth></source> Description:* Extra client '''extra''' — extra code. This is , a digital code, company`s unique identifier. Request this parameter from of the courier service you are integrating with. You can see this code in MeaSoft desktop interface by using its main menu * '''Referencelogin''' > — user name for the client account and API.* '''Additional Optionspass'''— password for the client account and API. Extra code is given in  Request the credentials from the second hyperlink (it is marked courier service you are integrating with an asterisk on the screenshot below): [[File:extra1.png|750px|none]]* LoginThe courier service gives you a temporary password. It is a user name for For security purposes, change it using your client account and API.  == Courier Service Access == To access API with courier service creates credentials, use the following connection string: <source lang=xml><auth extra="8" login="login in the client card on the " pass="pass" clientcode="123"></auth></source> Description: * '''Otherextra''' tab in — extra code, a unique identifier of the courier service. * '''login'''User — couerier service user name.* '''pass' field. You will probably have to create a new client card (shown on the screenshot below) in MeaSoft software'' — couerier service password.* Password. It is a password for '''clientcode''' — internal client account and API. Courier service creates password in code (see the client card on office application, the '''OtherClients''' tab , the "Internal code" column). To see the extra code, login and password, in the office application go to the '''PasswordAdditional Features''' fieldreference. (shown on the screenshot below). For more information, see [[File:33_client.pngCourier_Service_Account#Registering Courier Service Account|500px|noneRegistering Courier Service Account]].

login: testlogin password: testmpass

<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО LLC &quot;Miller and Partners&quot;" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Race car</item>

Courier service company can add required fields in the system settings. If you do not specify the required field values, an error message returns. <spoiler text="Example of order with minimum data"><source lang="xml"><?xml version="1.0" encoding="UTF-8"?><neworder> <auth extra="8" login="login" pass="pass" /> <order> <receiver> <company>Company</company> <phone>(495)123-45-67</phone> <address>Petrovka, 38</address> </receiver> </order></neworder></source></spoiler>'''Fields Description'''*'''neworder''' is a — root container, required. :*'''''newfolder''''' is an — attribute of a new order, possible values: '''YES''', '''NO'''. If '''YES''', a new order is created for the specified shipment in the courier service system. It is an optional element.

*'''order''' is a — container used for description of one order, required. A single '''neworder''' container can have a number of '''order''' containers to create several orders by using one query.:*'''''orderno''''' is an — order number. It should be entered here Specify it if it is assigned by the client. In case it is not assigned, this field can be left empty. The system will generate its own number and send it back in the response. The system checks whether the specified number has been used within the current calendar year. If it already exists in the system, the order is not created, error 17 "Such number exists" returns.

*'''barcode''' is an — order barcode. In case the customer uses barcodes for his dispatches and the barcode is different from the order number, the barcode is entered into this field. In case there are several packages and they are individually marked, underscore character can be used as a mask to indicate barcoded item number varying for different packages within one order.

*'''sender''' — presents the information about order sender. It is an optional container.

For the '''town''' tag, you can speify the value from the '''Regions ''' reference in the '''regioncode''' attribute. The town is searched for in the specified region.

*'''return_type ''' - return shipment type. It is transferred as a code from the '''Shipment Types''' reference.

*'''pickup''' — indicates whether it is a pickup order. If '''YES''', the entire order is considered to be the assignment for pickup, not for delivery. It is used for calling a courier to the sender's place to pick up shipments. '''Note'''. If warehouse goods are added to the order, their type must be '''[7]Goods pickup'''. Any other type is automatically changed to type 7 on submitting the order.

::1 — Goods. The default value.::2 — Delivery. The item is added automatically if '''order''' > '''deliveryprice''' is specified.::3 — Service::4 — Advance payment. The amount is specified. '''quantity''' is ignored, always "1". The amount in the order is displayed with the negative sign irrespective of the sign in the request. The item is added automatically if '''order''' > '''paytype=NO''' is specified.::6 - Credit payment. The amount is specified. '''quantity''' is ignored, always "1". The amount in the order is displayed with the negative sign irrespective of the sign in the request.::7 - Pickup. Use it if you have to pick up the items from the recipient. The amount in the order is displayed with the negative sign irrespective of the sign in the request.

* '''advprices''' — a container describing additional value-added services. It is an optional container. It has the following attributes: <span style="color: red;>To use it in the API, in the [[Courier Service Account#Setting Up Client Account|client account settings]], enable the '''Additional Value-added services''' field for new order and pickup request.</span>

If you want to apply additional value-added services (for example, delivery, cross-docking, lifting upstairs, etc.), specify them in the same '''items''' container as items without a SKU ID.

If a request is executed successfully and an order is created, the order amount in the <code>orderprice</code> attribute and the 0 error returns. Otherwise, an error number and its description in the <code>errormsgruerrormsg</code> attribute returns. The <code>orderno</code> attribute contains order number, <code>barcode</code> — order barcode.

<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="successSuccess" orderprice="5000"></createorder> <createorder orderno="55_6542AB23542" barcode="67567#115" error="0" errormsg="successSuccess" orderprice="6000"></createorder> <createorder orderno="AB23542AB23543" barcode="67567#116" error="0" errormsg="successSuccess" orderprice="0"></createorder>

<createorder orderno="AB23541" barcode="67567#114" error="1767" errormsg="Such number Order barcode already existsin the database."></createorder> <createorder orderno="AB23542" barcode="67567#115" error="1317" errormsg="empty companyOrder number already exists in the database."></createorder> <createorder orderno="AB23543" barcode="67567#116" error="1467" errormsg="empty personOrder barcode already exists in the database."></createorder>

 '''statusreq''' is a root container. Required. *'''auth''' —  — authorization. Required. *'''client''' —  — indicates whether it is a client or a delivery service partner. It is an optional element. Possible values: :* CLIENT — CLIENT — the default value.:* AGENT — AGENT — delivery service partner. Response contains information on the orders tendered for delivery. *'''orderno''' —  — order number. It is an optional element.*'''ordercode''' —  — internal order code. It is an optional element.*'''orderno2''' —  — urgent order number. It is an optional element. *'''datefrom''' —  — order creation date "from". It is an optional element. *'''dateto''' —  — order creation date "'to". It is an optional element. *'''target''' —  — a search text. You can specify a part of recipient company name or recipient address.*'''done''' —  — possible values: :* ONLY_DONE — ONLY_DONE — delivered only. Success stauses like '''Delivered''', '''Partially delivered'''.:* ONLY_NOT_DONE — ONLY_NOT_DONE — undelivered only. Statuses like '''Not delivered''', '''Lost'''.:* ONLY_NEW — ONLY_NEW — new only.:*ONLY_DELIVERY — ONLY_DELIVERY — orders in process only. These are orders in any status except for final statuses '''Delivered''', '''Not delivered''', '''Canceled''' and the like.:* ''Empty'' —  — for all shipments.*'''changes''' —  — can take only ONLY_LAST value. If this parameter is specified, all other parameters are ignored. For more information, see [[#Get Latest Changed Statuses|Get Latest Changed Statuses]].* '''conditions''' — specify search conditions. The nested elements are joined by the logical AND operator.:* '''namecontains''' — search order numbers (external codes) that contain the specified text.:* '''namestarts''' — search order numbers (external codes) that start with the specified text.

# You can request statuses of orders created no earlier than 2 months before the '''to''' date (<code>datefrom</code> and <code>dateto</code> containers). # If no date is provided, <code>dateto</code> equals the current date. # Omitting <code>dateto</code> defaults to <code>datefrom</code> plus two months.

<paytypecode="1">CASH</paytype>

All responce response fields correspond to the [[#Example of New Order|order creating request]] structure, with the following additions:

* '''''deliveryPIN''''' in '''receiver''' container — PIN.* '''pickup''' — indicates whether it is a pickup order. Possible values: '''YES''', '''NO'''. If '''YES''', the entire order is considered to be the assignment for pickup, not for delivery.

The '''deliveryprice''' tag includes additional value-added services. Option The option is available for the Premium and Maximum courier service account plans::* '''''advprice''''' — additional value-added service name.:* '''''code''''' — additional value-added service code.:* '''''price''''' — additional value-added service amount.

All response fields correspond to the [[#Creating Order|order creating responce response structure]], except for:

:* '''''orderno''''' — external order code.

** '''''orderno''''' — external order code.

<country>1RU</country>

== Goods Item Movement ==

:* '''orderno''' — external order code.

"towntofias": "7339e8340c5b2444-2cb470a0-47344932-a4c7980c-1fca2c66e562b4dc0d3f02b5", "towntocode": 1, "towntoname": "482Moscow city", "towntonamedistance": 0, "Ufa citypricedistance": 0,

{ "price": "200150", "every": "10", "mass": "25"

"price": 0, "300every": 1, "everymass": 38.01 }, { "1price": 15, "massevery": 1, "3mass": 51.01

"prices": { "before": { "mass": "3", "price": "202.5" }, "after": { "mass": "3", "everydeliveryPeriodMin": "1", "price": "18.75" } }, "deliveryPeriodMin": 4, "deliveryPeriodMax": 52

::* '''before/after — containers.:::* '''price''' — price. If the response is for the <code>before</code> container, <code>pricedistance</code> is also added to the amount.:::* '''every''' — for every specified number of pieces.:::* '''mass''' — weight.

== The list of order points of issue Pickup Points List ==

'''The To show pickup points on the map, use the [https://home.courierexe.ru/js/measoft_map.js JavaScript module]. See help info in the file. See example [https://home.courierexe.ru/pvz_test.html here]. Unique pickup point requests are cached on the client account side and retained till 7 AM GMT+3 of the next day. For example, if a unique request with a mass of 2 kg was submitted today at 10 AM, tommorow at 7 AM it will be deleted. If you submit a mass of 2 kg in the same request today at 6 PM, you will get the same list of pickup points . If you submit a mass of issue query:3 kg in the same request, you will probably get another list. '''Request Example'''

<code>1234</code> <client_code>7890</client_code> <city>Sverdlovsk Oblast</city> <townregioncode="66" country="RU">Nizhniy Nizhny Tagil</town> <parentcode>6</parentcode> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <maxweight>30</maxweight> <acceptindividuals>YES</acceptindividuals> <lt>57.924737</lt> <lg>59.940019</lg> <rt>57.905682</rt> <rg>59.984669</rg> <json>YES</json> <limit> <limitfrom>30</limitfrom> <limitcount>2</limitcount> <countall>YES</countall> </limit>

*'''auth''' — the '''extra''' attribute is required, it is used to determine the courier service company. '''login''' and '''pass''' allow to sign in as a client to apply the pickup points availability restrictions if they are set up for the client.*'''code''' — internal code.*'''client_code''' — courier service client code.*'''city''' - recipint region. You can specify a region code or a full region name from the '''Regions''' reference.*'''town''' — recipient location.:For the <code>town</code> tag, you can speify the value from the '''Regions''' reference in the <code>regioncode</code> attribute. The specified region is searched for the town.:In the <code>country</code> attribute, you can specify the recipient country according to the ISO 3166-1 standard. For example: "AT", "AUT" or "040" for Austria.*'''parentcode''' — parent [[#Branches List|branch]].*'''acceptcash''' — indicates whether cash on delivery is accepted. Possible values: '''YES''', '''NO'''.*'''acceptcard''' — indicates whether bank cards are accepted. Possible values: '''YES''', '''NO'''.*'''acceptfitting''' — indicates whether try-on is allowed. Possible values: '''YES''', '''NO'''.*'''maxweight''' — maximum weight allowed for the pickup point.*'''acceptindividuals''' — indicates whether pickup point is available for individuals. Possible values: '''YES''', '''NO'''.*'''lt''' — upper left corner latitude.*'''lg''' — upper left corner longitude.*'''rt''' — lower right corner latitude.*'''rg''' — lower right corner longitude.*'''json''' — indicates whether response is a receiver`s residencein JSON format. Possible values: '''YES''', '''NO'''.*'''limit''' — limits result output.:* '''limitfrom''' — defines the search result record number to start output with. The default value is '''0'''.:* '''limitcount''' — defines the quantity of search result records to show. The default value is '''100'''.:* '''countall''' — if '''YES''', the total quantity of found matches is counted. It might slow down the request execution. If disabled, <code>totalcount</code> is missing in the response.

'''The example of a response from the list of pick-up points:Response Example'''

<pvzlist count="2" totalcount="40465">

<comment>New pickup point</comment> <worktime>Sun 10:00-16:00, Sat 10:00-16:00, Mon-Fri 10:00-20:00</worktime> <traveldescription>5-storeyed storey apartment building with its end wall beside the highway, the second building from Parkhomenko-Tsiolkovsky street intersection.</commenttraveldescription> <maxweight>10</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>YES</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57.93457</latitude> <longitude>59.95131</longitude> <uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>

<name>At Krasnoarmeyskaya StreetOn Krasnoarmeiskaya</name> <parentcode>6</parentcode> <parentname>Integration</parentname> <town code="124267" regioncode="66" regionname="Sverdlovsk Oblast">>Nizhniy Tagil city</town> <address>Krasnoarmeiskaya, 79 KRASNOARMEYSKAYA STR.</address>

<comment>Working hoursTry-on is not allowed</comment> <worktime>Sun 10:00-16: from Monday through Friday00, from 9 a. m. till 6 p. m.Sat 10:00-16:00, on Saturday Mon- from Fri 10 a:00-20:00</worktime> <traveldescription>Next to McDonalds</traveldescription> <maxweight>20</maxweight> <acceptcash>YES</acceptcash> <acceptcard>YES</acceptcard> <acceptfitting>NO</acceptfitting> <acceptindividuals>YES</acceptindividuals> <latitude>57. m. till 2 p. m93468</latitude> <longitude>60.55476</longitude> <uid>41116853-9c51-11eb-b2c9-cfd6c1451392</commentuid>

*'''code''' is a — pickup point code of a point in the systemMeaSoft. It is used in an [[API#OrderingCreating Order|orderingcreating order request]] query.*'''clientcode''' is a — pickup point code of a in service partner system.*'''name''' — pickup point name.*'''parentcode''' — pickup point used by a contracting companyparent code. *'''parentname''' — pickup point parent name.*'''town' is a '' — locality with code from [[#City Names List|City Names List]] and region code and name of a point. *'''address''' is a — pickup point`s address. *'''phone''' are — pickup point phone numbersnumber. *'''comment''' — additional info.*'''worktime''' — pickup point working hours.*'''traveldescription''' — pickup point location description.*'''maxweight''' — maximum weight allowed for the pickup point.*'''acceptcash''' — indicates whether cash on delivery is additional informationaccepted. Possible values: '''YES''', '''NO'''.*'''acceptcard''' — indicates whether bank cards are accepted. Possible values: '''YES''', '''NO'''.*'''acceptfitting''' — indicates whether try-on is allowed. Possible values: '''YES''', '''NO'''.*'''latitude''' — location latitude.*'''longitude''' — location longitude.*'''uid''' — pickup point unique ID in MeaSoft.*'''count''' — number of response records.*'''totalcount''' — total number of relevant records.

== The list of types of priority Getting Order Fiscal Data ==

'''The example of a Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receiptdata> <auth extra="8" login="login" pass="pass" /> <orders> <order orderno="123456" /> <order orderno="890111C" /> </orders></receiptdata></source> '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><receipts count="1"> <receipt> <orderno>123456</orderno> <fdDatetime>2020-06-07 12:14:00</fdDatetime> <fdValue>123</fdValue> <fdNum>456</fdNum> <fnSn>789</fnSn> <kktNum>100</kktNum> <inn>222</inn> <ofdUrl>gate.ofd.ru</ofdUrl> <fullUrl>https://check.ofd.ru/123</fullUrl> <price>12345</price> <lines count="1"> <line> <item>1111764</item> <name>Boots</name> <qty>1</qty> <price>1000</price> <vatRate>20</vatRate> <governmentCode>Z16513LK2</governmentCode> <itemType>1</itemType> </line> </lines> </receipt></receipts></source>  '''Fields Description'''*'''orderno''' — order number.*'''fdDatetime''' — fiscal receipt issued date and time.*'''fdValue''' — fiscal document tag.*'''fdNum''' — fiscal document (receipt fiscal number).*'''fnSn''' — fiscal memory device number.*'''kktNum''' — cash registers number.*'''inn''' — TIN (taxpayer individual number).*'''ofdUrl''' — fiscal data operator URL address (domain name).*'''price''' — receipt amount.*'''fullUrl''' — receipt URL for online access.*'''lines''' — receipt items.:*'''item''' — item code.:*'''name''' — item name.:*'''qty''' — item quantity.:*'''price''' — item price.:*'''governmentCode''' — CHESTNYI Znak code sequence. It is processed by the 1162 tag algorithm.:*'''vatRate''' — item VAT rate.:*'''itemType''' — item type of priority query:(goods, delivery, etc.) == Urgency Kinds List == '''Request Example'''

'''The example of a response from the list of types of priority:Response Example'''

<name>UrgentlyUrgent</name>

== Delivery cost calculation Value-Added Services List ==

'''The example of a delivery cost query:Request Example'''

<?xml version="1.0" encoding="UTF-8" ?><calculatoradvprices> <auth extra="8" login="login" pass="pass" /> <visible>NO<calc townfrom="Moscow" townto="3800000300000" mass="3.7" service="1" /visible></calculatoradvprices>

Parameters:*'''townfromadvprices''' is a sending town— root container. Required. *'''towntovisible''' is a receiving town— indicates whether only the value-added services available in client account are returned. Optional. *Possible values: '''Yes''', '''massNo''' . The default value is weight in kilograms. *'''serviceNo''' is a delivery mode - a number indicating the entry in the list of [The list of types of priority|types of priority].

== Delivery Fee Calculation == '''The example of a cost of delivery response:Request Example'''

<?xml version="1.0" encoding="UTF-8"?>

<auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <calcsender> <town>Moscow</town> <address>Lenin street, 95</address> <townfrom codecoords lat="155.621048" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU">Moscow citySaint Petersburg</town> <address>Petrovka 38 office 35</address> <pvz>124</townfrompvz> <townto codecoords lat="55.680327" lon="5660337.604456">Irkutsk city</towntocoords> </receiver> <massweight>35.71</massweight> <service>12</service> <zonepaytype>2CASH</zonepaytype> <price>1163387.5</price> <deliveryprice>150</deliveryprice> <maxdeliverydaysinshprice>3387.5</maxdeliverydaysinshprice> <packages> <package mass="1" quantity="5"></package> <package mass="2.5" length="10" width="20" height="30"></package> </packages> <userid>user123</userid> <groupid>customer</groupid> </calcorder>

Parametersare the same as described in [[#Creating Order|Creating Order]]. '''Fields Description''' *'''pricetype''' — price type. Possible values: ** '''CUSTOMER''' — delivery price for end customer. The default value.** '''CLIENT''' — courier service price for client.*'''townfrom''' is a sending town name which has been recognized and assigned to the list of towns by the system- sender location.*'''addressfrom''' — sender address. *'''zipcode''' — recipient postal code.*'''townto''' — recipient location.*'''addressto''' — recipient address.*'''pvz''' attribute is a — pickup point code from the list of towns in the systemMeaSoft.*'''l''' — length in cm. Optional.*'''towntow''' is a receiving town name which has been recognized and assigned to the list of towns by the system— width in cm. Optional. *'''codeh''' attribute is a code from the list of towns — height in the systemcm. Optional.*'''mass''' is — weight in kilogramskg. *'''service''' is a — delivery mode - which is an integer specifying an '''Urgency Kinds''' list record. If the parameter is not specified, all available urgency kinds are calculated, with a number indicating lot of the entry <calc> containers in the list of [The list of types of priority|types of priority]response.*'''serviceprice''' is a — cash on delivery mode - the number indicating a certain entry in the list of types of priority (See the description on this page)amount. *'''zoneinshprice''' is the number of a tariff zone according to which the price has been calculated— declared value amount. The tariff schedule is selected depending on the tariff zone. Multiplying or decreasing coefficients can be applied to the price of delivery in case of order delivery not from/to a regional center*'''paytype''' — payment type. *'''priceuserid''' — user ID, either string or integer type. Virual field, optional. The field is a calculated delivery price used in the currency of a custom delivery service`s price-listrate settings. It is recommended defines the rule priority. You can use the field for CMS and CRM to be used rather than its homonymous attribute of the parent containerset delivery fee for each customer individually. *'''maxdeliverydaysgroupid''' — user group ID, either string or integer type. Virual field, optional. The field is used in the custom delivery rate settings. It defines the rule priority. You can use the maximum field for CMS and CRM to set delivery period in business daysfee for each customer group individually.

In authorization, you can omit the '''login''' and '''pass'''. In this case, the fee is calculated using courier service standard delivery rate, without taking into account possible differences for a certain client. Dimensional weight is calculated only if all the dimensions are provided: length, width, heigth. Sender and recipient location possible values:* location name (not recommended).* a code from the '''City Names''' list.* a 13-digit code of All-Russian Classifier of Addresses (Address Classifier used in Russia).* a 36-digit code of the Federal Information Address System (AOGUID).   '''Response Example''The example '<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><calculator> <calc> <townfrom code="1">Moscow city</townfrom> <townto code="56603">Irkutsk city</townto> <mass>3.7</mass> <service name="Express">1</service> <zone>2</zone> <price>1113</price> <mindeliverydays>1</mindeliverydays> <maxdeliverydays>3</maxdeliverydays> <mindeliverydate>2020-05-13</mindeliverydate> <deliveryprice> <advprice code="1" price="1000">Base</advprice> <advprice code="4" price="100">Amount percent</advprice> <advprice code="5" price="63">Declared value percent</advprice> <advprice code="6" price="-50">Discount on delivery</advprice> </deliveryprice> </calc></calculator></source> Parameters: *'''townfrom''' — sender location as recognized and assigned to the list of cities by the query for system. **'''code''' — a code from the '''City Names''' list.*'''townto''' — recipient location as recognized and assigned to the list of money transfer certificatescities by the system. **'''code''' — a code from the '''City Names''' list.*'''mass''' — weight in kilograms. *'''service''' — delivery mode which is an integer specifying an '''Urgency Kinds''' list record. If the parameter is not specified, all available urgency kinds are calculated, with a lot of the <calc> containers in response.*'''zone''' — number of the rate zone used in the calculation. The shipping rate schedule is selected depending on the zone. Coefficients can be applied to the shipping cost if the order is not delivered from or to a regional center. *'''price''' — shipping cost in the currency of the courier service. We recommend that you use this parameter. *'''maxdeliverydays''' — maximum number of busines days in transit.*'''mindeliverydate''' — closest delivery date considering holidays.*'''deliveryprice''' — contains shipping cost details. '''Note''':the actual server response contains the <code>price</code> attribute in the <code>calc</code> tag. It is retained for backward compatibility, use nested <code>price</code> tag instead. == Getting Client Info == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <auth extra="8" login="login" pass="pass" /> </client></source> '''client''' — root container. Required.*'''auth''' — authorization. Required. '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> *'''code''' — client code. == List of Сash Transfer Certificates == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smalist> <auth extra="8" login="login" pass="pass" /> <datefrom>20162021-02-10</datefrom> <dateto>20162021-03-10</dateto></smalist></source> '''smalist''' — root container. Required. *'''auth''' — authorization. Required. *'''datefrom''' — date from. Optional. *'''dateto''' — date to. Optional.  If the date range is not specified, cash transfer certificates for the last month are returned.  '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smalist count="1"> <sma> <code>6278</code> <number>3992</number> <actdate>2020-02-12</actdate> <datepay></datepay> <dateto>2020-02-12</dateto> <promiseddatepay></promiseddatepay> <price>637.00</price> <pricecorr>113.00</pricecorr> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67.00</priceag> <payno>42423</payno> <paytype>1</paytype> <paytypename></paytypename> /not supported yet <signedcopyreceived>NO</signedcopyreceived> </sma></smalist></source> *'''code''' — cash transfer certificate code.*'''number''' — cash transfer certificate number in MeaSoft. *'''actdate''' — date cash transfer certificate created.*'''datepay''' — date cash transfer certificate paid. *'''dateto''' — cash transfer certificate period end date.*'''promiseddatepay''' — planned payment date.*'''price''' — cost of courier services.*'''pricecorr''' — adjustment amount.*'''rur''' — order amount. *'''pricekur''' — courier delivery cost. *'''priceag''' — service partner fee. *'''payno''' — payment order number. *'''paytype''' — type of payment: 1 — non-cash payment, 2 — paying a courier in cash, 3 — paying cash at the office, 4 — payment to bank card.*'''paytypename''' — payment type as string.*'''signedcopyreceived''' — indicates whether cash transfer certificate is returned. Possible values: '''YES''', '''NO'''. == Cash Transfer Certificate Breakdown == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><smadetail> <auth extra="8" login="login" pass="pass" /> <code>6278</code></smadetail></source> '''smadetail''' — root container. Required. *'''auth''' — authorization. Required.*'''code''' — cash transfer certificate [[#List of Сash Transfer Certificates|code]]. Required.  '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><smadetail count="2"> <specialsma> <code>42494</code> <ordercode>14424</ordercode> <orderno>11111</orderno> <orderdate>2021-01-01</orderdate> <delivereddate>2021-10-01</delivereddate> <company>Company</company> <price>314.00</price> <rur>8800.00</rur> <inshprice>314.00</inshprice> <pricekur>270.00</pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>2</paytype> <paytypename>paying a courier in cash</paytypename> <weight>0.400</weight> <distance>0.0</distance> <status>Delivered</status> </specialsma></smadetail>

*'''smalistcode''' is a root container— record code. Required*'''ordercode''' — external order code. *'''authorderno''' is authorization— order cipher. Required*'''orderdate''' — order date. *'''datefromdelivereddate''' is a — delivery date “from”. Optional*'''company''' — recipient.*'''price''' — cost of courier services.*'''rur''' — order amount.*'''inshprice''' — order cost.*'''pricekur''' — courier delivery cost.*'''priceag''' — service partner fee.*'''pricecalc''' — amount to pay to service partner. *'''datetopaytype''' is — type of payment: 1 — non-cash payment, 2 — paying a date “to”courier in cash, 3 — paying cash at the office, 4 — payment to bank card.*'''paytypename''' — payment type as string.*'''weight''' — order weight.*'''distance''' — order distance. Optional*'''status''' — order status.  == URL Shortener ==

If the date range is not specifiedSometimes, then money transfer certificates for the last month are returnedyou might want to use short links to client account. For instance, when sending an SMS to recipient.

To get a short URL, send a request with a full URL. Hash value for a short link is returned.  '''The example of a response to the query for the list of money transfer certificates:Request Example'''

<?xml version="1.0" encoding="UTF-8"?><smalist count="1"shortlink> <sma> <codelink short="0">6278<https:/code> <number>3992</number> <actdate>2016-02-12</actdate> <datepay></datepay> <price>637home.00</price> <rur>13430.00</rur> <pricekur>570.00</pricekur> <priceag>67courierexe.00<ru/priceag> <payno>42423<8/payno> <paytype>1<site/paytype> orders</smalink></smalistshortlink>

*'''codeshortlink''' is a code of a money transfer certificate— root container. *'''number''' is the number of a money transfer certificate in the systemRequired. *'''actdatelink''' is a date of a money transfer certificate— long link to shorten.*'''datepay''' is a date of payment on a money transfer certificateRequired. *If '''priceshort''' value is a price of services. *'''rur''' is a price of an order. *1'''pricekur''' is a price of courier delivery. *'''priceag''' is agent`s commission. *'''payno''' is a number of a payment order. *'''paytype''' is a type of payment: 1 — non-cash payment, 2 — paying a courier in cash, 3 — paying cash at the officereturn contains only hash code, 4 — wire transferno XML.

== Detailing of money transfer certificates == '''The examples of the query for money transfer certificates detailing:Response Example'''

<?xml version="1.0" encoding="UTF-8" ?><smadetailshortlink> <auth extra="8" login="login" pass="pass" /> <codehash>627835AF350C</codehash></smadetailshortlink>

*'''smadetailhash''' is a root container. Required— URL hash code. *'''auth''' is authorization. Required.*'''code''' is a code of a money transfer certificate (See the query of the list of money transfer certificates). Required. Use it as client account URL:

'''The example of a response to the query of money transfer certificates:'''<source lang="xml"nowiki><?xml version="1.0" encoding="UTF-8"?><smadetail count="1"> <specialsma> <code>42494<https:/code> <addresscode>14424</addresscode> <price>314home.00</price> <rur>8800courierexe.00<ru/rur> <pricekur>27035AF350C or curie.00<ru/pricekur> <priceag>44.00</priceag> <pricecalc>8486.00</pricecalc> <paytype>Cash on delivery</paytype> <status>Delivered</status> </specialsma> <specialsma> <code>42495</code> <addresscode>14415</addresscode> <price>323.00</price> <rur>4630.00</rur> <pricekur>300.00</pricekur> <priceag>23.00</priceag> <pricecalc>4306.00</pricecalc> <paytype>Cash on delivery</paytype> <status>Delivered</status> </specialsma></smadetail>35AF350C</sourcenowiki>

*'''codeNote''' is a code of the record. *'''addresscode''' is a code of the order. *'''price''' is a price of service *'''rur''' is the amount of the order. *'''pricekur''' is a price of courier delivery. *'''priceag''' is agent`s commission. *'''pricecalc''' is the amount to be transferred to the agent. *'''paytype''' is a type of payment: 1- non-cash payment, 2 - paying a courier in cash, 3 - paying cash at the office, 4 - wire transfer. *'''status''' URL shortener is a status of the orderonly for MeaSoft company sites.

== Generation of short links Recipient Rating Check ==

In some cases, The check is available only for instance, when using them in SMS, the use of short links to member area may be requiredMaximum personal account plan.

<shortlinkmcheck> <link shortauth extra="08" login="login" pass="pass"/> <phones> <phone>https:89161147992<//home.courierexe.ru/8/site/ordersphone> </linkphones></shortlinkmcheck>

'''shortlinkResponse Example''' is a root container. Required.*'''link''' is a full link for generation of which a code should be obtained. Required. If '''short''' attribute equals 1, then a response won`t contain XML but only a hash code.

<?xml version="1.0" encoding="UTF-8"?><shortlinkmcheck> <hashphones>35AF350C <phone rate="90">89161147992</phone> </hashphones></shortlinkmcheck>