Изменения

MeaSoft has an option of integration by means of XML API under through HTTP POST protocol.

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 you should , 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>

For MeaSoft, only three fields are required:* either receiver->company or receiver->person*'''neworder''' is a root container, a mandatory element. receiver->address :*'''''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 elementreceiver->phone.

*'''order''' is a container used for description of one order, a mandatory element. 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 if it is assigned by the client. In case it is not assigned, this field Courier service company can be left empty. The system will generate its own number and send it back add required fields in the response. The system checks whether the specified number has been used within the current calendar yearsettings. If it already exists in you do not specify the system, the order is not createdrequired field values, an error 17 "Such number exists" 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''' — root container, required. :*'''barcode''newfolder''''' — 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''' — 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''''' — order number. 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''' — 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.

* '''receiver''' is the information about the recipient. It is a mandatory containerRequired.

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. It is a mandatory elementRequired. *'''auth''' —  — authorization. It is a mandatory elementRequired. *'''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.

* '''auth''' — Authorization. Required.* '''streamid''' - stream ID. If you get order statuses for multiple integrations, pass this parameter to divide getting statuses and sending confirmation. The value must be from 100 up to 10000. It is a mandatory an optional element.

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

'''Status Request Order Cancelation Fields'''

'''cancelorder''' — root container. It is a mandatory elementRequired.* '''auth''' — authorization. It is a mandatory elementRequired.* '''order''' — container of the order being canceled. It is a mandatory elementRequired. The request can contain more than one '''order'''. It has the following attributes::* '''''orderno''''' — external order code.

Either '''''orderno''''' or '''''ordercode''''' is required.

== Status change by agent Adding Files to Order == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><addattachments> <auth extra="8" login="login" pass="pass" /> <orderno>1234567</orderno> <attachments> <item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item> </attachments></addattachments></source>  '''Fields Description''' '''addattachments''' — root container. Required.*'''auth''' — authorization. Required.*'''orderno''' — order number. Required. You can use tag <code>ordercode</code> to specify order internal code.*'''attachments''' — file data. Required.**'''item''' — base64 encoded binary file data. Required.***'''name''' — an '''item''' attribute that contains the file name. Required.  '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><addattachments> <attachments> <item name="photo1.jpg" error="0" errormsg="OK" /> <item name="photo2.jpg" error="0" errormsg="OK" /> </attachments></addattachments></source> == Getting Order Files == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><attachments> <auth extra="8" login="login" pass="pass" /> <orderno>1234567</orderno></attachments></source> '''Fileds Description''' '''attachments''' — Root container. Required.*'''auth''' — authorization. Required.*'''orderno''' — order number or code. Required.  '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><attachments> <item name="doc1.docx" size="35654">JVBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL XhEZWNvZGUNPj4Nc3RyZWFt DQ</item> <item name="photo2.jpg" size="74861">VBERi0xLjMN JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item></attachments></source> The <code>item</code> tag contains base 64 encoded binary data (files).

Besides that, date and time (in necessary) of Order status change as well as a type request allows to get the final status of message in "Information on delivery" field are setthe order — either '''Delivered''' or '''Not delivered (Returned/Canceled)'''.

If Besides, the request gets date and time of status change, if necessary, images can be attached to and the order information'''Delivery info''' field message.

You can attach images to the order. '''The example of a status change requestRequest Example:'''

<order ordercode="123456" date> <message>Accepted by Tailor</message> <outstrbarcode>7654312</outstrbarcode> </order> <order ordercode="2018234567"> <status>PICKUPREADY</status> <eventtime>2021-0305-0130 10:20:00</eventtime> <message>Client refused the order</message> <paytype>CASH</paytype> <items> <item code=" time34533" quantity="10:001" messagereason="The customer has refused from the purchase0"/> <order ordercodeitem code="34456" quantity="0" reason="2345670" date/> <item code="2018-03-0134421" timequantity="10:002" messagereason="0"/> </items> <image filename="filename1.jpg">/9j/4AAQSkZJRgABAQAAAQABAAD4AAQSkZJRgA BAQAAAQABAAD/2wBDAA0JCgsKCA0LCgsODg0PEyAVExISEy2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy ccHhcgLikxMC4pLSwzOko+MzZGNywtQFdBRkxOUlNSMj5aYVpQYEpRUkM zZGNywtQFdBRkxOUlNSMj5aY VpQYEpRUk//2wBDAQ4ODhMREyYVFSZPNS01T09PT09PT09P2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09 T09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0PT09PT0//wAARCAYACAADASIAwAARCAYACAADAS IA</image>

'''The description of status response fields:Fields Description'''

'''setorderinfo''' is a — root container. It is a mandatory elementRequired. *'''auth''' is — authorization. It is a mandatory elementRequired. *'''order''' is — order container. It is a mandatory elementRequired. A query may request can contain more than one '''order''' container. It has the following attributesattribute: :* '''''ordercode''''' is — an internal order code of an .*'''status''' — new orderstatus. It can be any [[#Response Fields|status]] excepting AWAITING_SYNC and NEW.:* '''eventtime'''— status change dateand time. Required if status is specified. *'''message'' ' — delivery info text. *'''outstrbarcode''' — code in service partner system (order code in external system). It is status change dateused in integrations with external systems.*'''paytype''' — order payment type. Possible values are '''CASH''' and '''CARD'''.*'''items''' — container that describes order items. It has the following attributes::* '''''code''''' — item code.:* '''''quantity''''' — quantity of delivered articles. :* '''''timereason''''' — reason for non-delivery. It is selected from the status change timelist.*'''image''' — container for the image being attached. It contains base 64 encoded image file text. The '''order''' container can contain more than one '''image''' container. It has the following attribute: :* '''''messagefilename''''' is message text— file name.

*'''image''' is an attached image container. It contains image file text coded according to ''base64'' standard. '''order''' container may contain more than one '''image''' container. It has the following attribute: :* '''''filename''''' is a file name.'''The example of a response:Response Example'''

<order ordercode="123456" error="0" errormsg="OK" errormsgru="Successfully" /> <order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="The value [Date of delivery] is already set" />

== Obtaining the pdf waybill Getting Documents for Printing ==

'''Get Print Forms Request example:Example'''

<orders> <order orderno="1234567" ordercode="33331" /> <order orderno="1234568" ordercode="33332" />1234567 </ordernoorders>

'''The fields description:Fields Description'''

'''waybill''' - — is a root container. It is a mandatory elementRequired. *'''auth''' - — is authorization. Required.*'''orders''' — list of orders to get print forms for. It is a mandatory elementcontains tags '''order''' with the following attributes:** '''''orderno''''' — external order code. ** '''''ordercode''orderno''' - Order number— internal order code. It *: Specify either of the attributes for all the orders. The '''''ordercode''''' attribute is a mandatory elementrecommended. *'''form''' - Form type— packing slip format. Is not mandatoryOptional. Can bePossible values::* '''1 - A ''' — detailed waybillpacking slip. Default value.:* '''2 - Sticker (''' — Zebra)label.:* '''3''' — A4 size label.:* '''4''' — delivery and acceptance certificate.

'''Response example:Example'''

The '''''content''''' tag contains pdf binary, base64 encoded. == Cancellation of order == Cancel request is intended to be used for cancellation of those orders about which no changes have been made - like delivery status, correspondence status and delivery time - in other words, those orders which are not being processed.  In case of order cancellation “Delivery information” field gets the value “Cancelled by the customer” and “Delivery date” field gets a current datebinary data (PDF file).

'''The example of a query for order cancellation:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelorder> <auth extra="8" login="login" pass="pass" /> <order orderno="" ordercode="123456" /> <order orderno="123aaa" ordercode="" /></cancelorder></source>  '''The description of status query fields:''' '''cancelorder''' is a root container. It is a mandatory element. *'''auth''' is authorization. It is a mandatory element.*'''order''' is a cancelled order container. It is a mandatory element. A query may contain more than one '''order''' container. It has the following attributes::* '''''orderno''''' is order`s cipher. :* '''''ordercode''''' is an internal code of the order. Please, note that at least one of ''orderno'' or ''ordercode'' attributes should be specified!   '''The example of a response:'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><cancelorder> <order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Successfully" /> <order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="The order is not found" /></cancelorder></source> == City names list == '''The example of the city names list query:List Request Example'''

<country>1RU</country>

All elements inside The <code>townlist </code> container can either be absent empty or combineelements. The search is not case-sensitiveinsensitive. *'''auth''' — authorisation, optional. Use it if the courier service set and enabled some location restrictions. *'''codesearch''' is a — search by codes. In case when When it is used, the <code>conditions </code> and <code>limit </code> containers will be are ignored. :* '''zipcode''' is a — search by zip postal codes. Please, note Note that one zip postal code can be applicable to several more than one localities. In this case the system will return MeaSoft returns several records.:* '''kladrcode''' is a — search by 13-digit codes code of All-Russian Classifier of Addresses.:* '''fiascode''' is a — search by codes the code of Federal Information Address System (Address address system used in Russia) (AOIDAOGUID).:* '''code''' is a — search by codes of the systemcode.

*'''conditions''' — specifies search criteria. All enclose nested elements simultaneously impose “AND” the AND condition. :* '''city''' is a — search by for all the localities of a region. :* '''namecontains''' is a — search of for the localities which with names contain a specified including the search text. :* '''namestarts''' is a — search of for the localities which with names start from a specified starting with the search text.:* '''name''' is a — search of for the localities which with names match a specified matching the search text.:* '''fullname''' is a — search of for the localities which with names and type match a specified matching the search text. :* '''country''' is a — search of in the country with a the specified zip codeonly.

*'''limit''' — limits result output. :* '''limitfrom''' specifies — defines the search result record number of a search result starting to start output with which a response should be given. It equals The default value is '''0 by default'''. :* '''limitcount''' specifies — defines the number quantity of search result records which should be returnedto show. It equals The default value is '''10000 by default'''.:* '''countall''' - — if '''YES indicates ''', the necessity of counting the amount total quantity of found matches foundis counted. It may might slow down the process of query request execution. In case it is If disabled, <code>totalcount </code> and <code>totalpages values won`t be indicated </code> are missing in the response.

'''The example of a response:Response Example'''

<name>Krasnodar TerritoryKrai</name>

<shortnamefiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>Sochi2300000700000</kladrcode> <shortname/> (not yet supported) <typename>city</typename> (not yet supported) <coords lat="43.5855" lon="39.7231" />

<name>Bryanskaya oblastBryansk District</name>

<name>Sochilov farmsteadkhutor</name> <shortnamefiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>Sochilov3201900011100</kladrcode> <shortname/> <typename/>farmstead <coords lat="52.6407" lon="33.1724" /typename>

<name>Pskov oblastDistrict</name>

<shortnamefiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>Sochikhino6001900015400</kladrcode> <shortname/> <typename/>village <coords lat="56.6003" lon="29.3542" /typename>

In a the response , the cities and towns are sorted arranged by their popularity, importance (district centers, etc.) and only after that - alphabeticallythen by alphabet.

== Region names list Names List ==

'''The example of the region names list query:Request Example'''

<namecontains>TerritoryKrai</namecontains>

<fullname>Moscow regionOblast</fullname>

'''The example of a response:Response Example'''

<name>Agin-Buryat Autonomous AreaOkrug</name>

== Street names guide Names List ==

'''The example of the city names list query:Request Example'''

<town>Moscow city</town> // MANDATORY REQUIRED FIELD!

*'''conditions''' specifies — search criteria. All enclose nested elements simultaneously impose “AND” the AND condition.:* '''town''' is a mandatory — required field. It`s is the name or the code of a locality.:* '''namecontains''' is a — search of for the localities which streets with names contain a specified including the search text.:* '''namestarts''' is a — search of for the localities which streets with names start from a specified starting with the search text.:* '''name''' is a — search of for the localities which streets with names match a specified matching the search text.:* '''fullname''' is a — search of for the localities which streets with names and type match a specified matching the search text.

:* '''limitfrom''' specifies — defines the search result record number of a search result starting to start output with which a response should be given. It equals The default value is '''0 by default'''. :* '''limitcount''' specifies — defines the number quantity of search result records which should be returnedto show. It equals The default value is '''10000 by default'''.:* '''countall''' - — if '''YES indicates ''', the necessity of counting the amount total quantity of found matches foundis counted. It may might slow down the process of query request execution. In case it is If disabled, <code>totalcount </code> and <code>totalpages values won`t be indicated </code> are missing in the response.

'''The example of a response:Response Example'''

In a the response , the street names of the streets are sorted in alphabetical orderarranged alphabetically.

== Nomenclature list List of Goods ==

'''The example of the nomenclature list query:Request Example'''

<name>Sony KDL-55W905 LCD televisionTV</name>

All elements inside itemlist The <code>townlist</code> container can either be absent empty or combineelements. The search is not case-sensitiveinsensitive. *'''codesearch''' is a — search by codes. In case when When it is used, the <code>conditions </code> and <code>limit </code> containers will be are ignored.:* '''code''' is a — search by codes of the internal systemcode.:* '''article''' is a — search by article numbersSKU ID. :* '''barcode''' is a — search by barcode.  *'''conditions''' — specifies search criteria. All nested elements simultaneously impose the AND condition.:* '''namecontains''' — search for the goods with names containing the search text.:* '''namestarts''' — search for the goods with names starting from the search text.:* '''name''' — search for the goods with names matching the search text.:* '''quantity''' — availability of goods in the warehouse. Sometimes, the field may be unavailable. Possible values:*** '''EXISTING_ONLY''' — only in stock.*** '''NOT_EXISTING_ONLY''' — only out of stock.*** '''ALL''' — all. :* '''store''' — search by barcodesthe specified warehouse.

*'''conditionsexcept''' specifies search criteria. All enclose elements simultaneously impose “AND” condition.:* '''namecontains''' is a search — exception description for correct counting of the goods which names contain a specified textreserved items.:* '''namestartscode''' is a search of the goods which names start from a specified text— order code.:* '''name''' is a search of the goods which names match a specified text.:* '''quantity''' is the availability of goods at the warehouse. It can have the following values: EXISTING_ONLY - only in stock, NOT_EXISTING_ONLY - only stock out, ALL - all. ''In some setups this field may be unavailable.''

*'''limit''' — limits result output.:* '''limitfrom''' specifies — defines the search result record number of a search result starting to start output with which a response should be given.:* '''limitcount''' specifies — defines the number quantity of search result records which should be returnedto show.

'''The example of a response:Response Example'''

<name>Sony KDL-55W905 LCD televisionTV</name>

<Message>A good TV set</Message> <Message2>Another good TV set</Message2>

'''The description of fields:Fields Description'''*'''code''' is an — internal identifier assigned by the system. *'''article''' is an article assigned by a customer (a — supplier)SKU ID. *'''barcode''' — manufacturer barcode. *'''name''' — item name. *'''retprice''' — default retail price. When creating the order, the price specified in the order is used.*'''purchprice''' — purchase price.*'''weight''' — weight in kilograms. *'''length''' — length in centimeters. *'''width''' — width in centimeters. *'''height''' — height in centimeters.*'''VATrate''' — value-added tax rate, integer.*'''CountInPallet''' — number of pieces in a manufacturer`s barcodepallet. *'''HasSerials''' — indicates whether serial numbers tracking is used. Possible values: '''1''' — Yes, '''0''' — No. *'''CountryOfOrigin''' — name of the country of origin. *'''Message''' — comment. *'''Message2''' — additional comment. *'''quantity''' — quantity in stock. Goods picked up for orders are not included in this number, they are considered to be shipped. ''This field may be unavailable in some setups.''*'''reserved''' — quantity of goods reserved. It may outnumber the stock balance if customers are waiting for the next delivery. ''This field may be unavailable in some setups. '' == Goods Movement ==

*'''nameRequest Example''' is an item name<source lang="xml"><?xml version="1. 0" encoding="UTF-8" ?><itemmovements> <auth extra="8" login="login" pass="pass"></auth> <code>4259</code> <datefrom>2020-10-01</datefrom> <dateto>2020-10-02</dateto></itemmovements></source>

*'''retpricecode''' is a retail price value by default. When ordering the price which is mentioned — internal item code in the order is usedlist of goods.*'''datefrom''' — period start date.*'''dateto''' — period end date.You can specify either code or period, or both code and period.

*'''widthResponse Example''' is width in centimeters<source lang="xml"><?xml version="1. 0" encoding="UTF-8" ?><itemmovements count="16"> <itemmovement> <code>151500</code> <date>2020-10-01</date> <retprice>0</retprice> <quantity>1</quantity> <delivered>0</delivered> <item> <code>4259</code> <name>Jenga Classic Game</name> </item> <status> <code>5</code> <name>Return from customer</name> </status> <store> <code>1</code> <name>Moscow office</name> </store> <order> <ordercode>3374830</ordercode> <number>123660-0</number> <date>2020-10-01</date> <orderno>14123</orderno> <barcode>0000000670</barcode> <company>All Games</company> <address>Thompson str., 88</address> <delivereddate>2020-05-29</delivereddate> <deliveredtime>12:00:00</deliveredtime> <deliveredto /> </order> <document> <code>21991</code> <number>318</number> <date>2020-05-26</date> <message></message> </document> </itemmovements></itemlist></source>

'''Fields Description'''*'''code''' — goods movement internal transaction code.*'''date''' — transaction date.*'''heightretprice''' is height — item price.*'''quantity''' — item quantity in centimetersthe movement transaction.*'''delivered''' — quantity of delivered items.

*'''CountInPalletitem''' is the number of pieces in a pallet— goods item container.:* '''code''' — item internal code.:* '''name''' — item name.

*'''HasSerialsstatus''' requires serial numbers accounting— transaction status container. It takes on the following values: 1 - yes, 0 - no* '''code''' — status code.:* '''name''' — name.

*'''CountryOfOriginstore''' is — container for the name of a country of origin in Russianbranch that performs the transaction.:* '''code''' — branch code. :*'''Messagename''' is a commentary— branch name.

*'''Message2order''' is an additional commentary— shipment container.:* '''ordercode''' — internal order code.:* '''number''' — order number.:* '''date''' — order date.:* '''orderno''' — external order code.:* '''barcode''' — barcode.:* '''company''' — company.:* '''address''' — address.:* '''delivereddate''' — date delivered.:* '''deliveredtime''' — time delivered.:* '''deliveredto''' — delivery info or reason for non-delivery.

*'''quantitydocument''' is the — transaction document container.:* '''code''' — internal document code.:* '''number''' — document number of goods in stock. Those goods that have already been batched into orders are not included in this :* '''extnumber''' — external document number and considered to depart the depository for goods. :* '''This field may be unavailable in some setupsdate''' — document date.:* '''message''' — comment.

*'''reserved''' is the number of goods reserved. It may outnumber stock balance if customers are waiting == Getting Shipping Rates for the next delivery. ''This field may be unavailable in some setups.'' Towns and Cities ==

<div style== The list of order points of issue =="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">If the <code>nofederal</code> parameter is missing in the request, Moscow is processed in the following way: the response contains Moscow and Moscow region towns and distance markup.</div>

'''The Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><tariffs> <auth extra="8" login="login" pass="pass" /> <townfrom>Moscow</townfrom> <service>1</service> <mainonly>1</mainonly> </tariffs></source> *'''auth''' — the '''extra''' attribute is required, it is used to determine the courier service company.*'''townfrom''' — sender town or city. If it is not passed, the default value is '''Moscow'''.*'''service''' — delivery mode. Required.*'''mainonly''' — optional. If passed, the response contains data from the '''Inter-city''' > '''Zones''' table only.* '''nofederal''' — optional. If passed, a city of federal importance is processed as an ordinary city.  '''Response Example'''<source lang="json">{ "townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "service": 1, "tariffs": [ { "towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "towntocode": 1, "towntoname": "Moscow city", "distance": 0, "pricedistance": 0, "pricesnew": { "before": [ { "price": "100", "every": "0", "mass": "1" }, { "price": "150", "every": "0", "mass": "5" } ], "after": [ { "price": 0, "every": 1, "mass": 38.01 }, { "price": 15, "every": 1, "mass": 51.01 } ] }, "deliveryPeriodMin": 1, "deliveryPeriodMax": 2 } ]}</source> '''Fields Description'''* '''townfrom''' — sender locality [[#City Names List|AOGUID]] (Federal Information Address System) code.* '''service''' — delivery mode.*'''tariffs''' — shipping rates list for the locality.:* '''towntofias''' — recipient locality AOGUID code.:* '''towntocode''' — recipient locality internal code.:* '''towntoname''' — recipient locality name.:* '''distance''' — distance in km from Moscow to Moscow Ring Road if <code>townfrom</code> is Moscow.:* '''pricedistance''' — Moscow to Moscow Ring Road distance markup if <code>townfrom</code> is Moscow..:* '''pricesnew''' — your shipping rates from the '''Inter-city''' > '''Rates by Zones''' table.::* '''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.:* '''prices''' — obsolete, do not use.:* '''deliveryPeriodMin''' — minimum number of days in transit.:* '''deliveryPeriodMax''' — maximum number of days in transit. == Receipt Items == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <auth extra="8" login="login" pass="pass"></auth> <code>21991</code></itemdoc></source> *'''code''' — internal receipt document code.  '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><itemdoc> <code>21991</code> <number>318</number> <date>2021-05-26</date> <message></message> <items> <item code="4259" quantity="1" barcode="200300" article="123555">Jenga Classic Game</item> </items></itemdoc></source> '''Fields Description'''* '''code''' — internal receipt code.* '''number''' — document number.* '''date''' — document date.* '''message''' — comment. *'''item''' — goods item container.:* '''code''' — internal item code.:* '''barcode''' — item barcode.:* '''article''' — item SKU ID.:* '''quantity''' — quantity of received items. == Branches List == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist> <auth extra="8"></auth> <json>YES</json> <client_code>7890</client_code></storelist></source> *'''auth''' — the '''extra''' attribute is required, it is used to determine the courier service company.*'''json''' — indicates whether response is in JSON format. Possible values are '''YES''', '''NO'''.*'''client_code''' — courier service client code. '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><storelist count="2"> <store> <code>123</code> <name>ABC</name> </store> <store> <code>456</code> <name>Branch 2</name> </store></storelist></source> *'''code''' — branch code. *'''name''' — branch name. == Pickup Points List == 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 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'''.*'''latitude''' — location latitude.*'''longitude''' — location longitude.*'''uid''' — pickup point unique ID in MeaSoft.*'''count''' — number of response records.*'''totalcount''' — total number of relevant records. == Getting Order Fiscal Data == '''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 additional informationprocessed by the 1162 tag algorithm.:*'''vatRate''' — item VAT rate.:*'''itemType''' — item type (goods, delivery, etc.)

== The list of types of priority Urgency Kinds List ==

'''The example of a type of priority query: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 == '''Request Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8"?><advprices> <auth extra="8" login="login" pass="pass" /> <visible>NO</visible></advprices></source> '''advprices''' — root container. Required. *'''visible''' — indicates whether only the value-added services available in client account are returned. Optional. Possible values: '''Yes''', '''No'''. The default value is '''No'''. 

'''The example Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><advprices> <advprice> <code>1</code> <name>Number of a delivery cost queryfloors in the building</name> <type>int</type> </advprice> <advprice> <code>2</code> <name>Markup coefficient </name> <type>float</type> </advprice> <advprice> <code>3</code> <name>Heavy lift</name> <type>bool</type> </advprice></advprices></source> Параметры:*'''code''' — internal service code.*'''name''' — service name. If in the '''Value-Added Services''' list the '''Name in client account''' column is not empty, the column value is returned.<!--*'''hine''' — value-added service hint for user.-->*'''type''' — service type. Possible values::*'''bool''' — for services with the '''Check box''' input type.:*'''float''' — for services with the '''Float''' input type.:*'''int''' — for services with the '''Integer''' input type. == Delivery Fee Calculation == '''Request Example'''

<auth extra="8" login="login" pass="pass" /> <order> <pricetype>CUSTOMER</pricetype> <calc townfromsender> <town>Moscow</town> <address>Lenin street, 95</address> <coords lat="Moscow55.621048" lon="37.604456"></coords> </sender> <receiver> <zipcode>125480</zipcode> <town regioncode="78" country="RU" townto>Saint Petersburg</town> <address>Petrovka 38 office 35</address> <pvz>124</pvz> <coords lat="380000030000055.680327" masslon="337.7604456" ></coords> </receiver> <weight>5.1</weight> <service>2</service> <paytype>CASH</paytype> <price>387.5</price> <deliveryprice>150</deliveryprice> <inshprice>387.5</inshprice> <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> </order>

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- sender location.*'''addressfrom''' — sender address.*'''zipcode''' — recipient postal code. *'''townto''' is a receiving town— recipient location.*'''addressto''' — recipient address.*'''pvz''' — pickup point code in MeaSoft.*'''l''' — length in cm. Optional.*'''w''' — width in cm. Optional.*'''h''' — height in cm. 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 response.*'''price''' — cash on delivery amount.*'''inshprice''' — declared value amount.*'''paytype''' — payment type.*'''userid''' — user 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 list of [field for CMS and CRM to set delivery fee for each customer individually.*'''groupid''' — user group ID, either string or integer type. Virual field, optional. The list of types of field is used in the custom delivery rate settings. It defines the rule priority|types of priority]. You can use the field for CMS and CRM to set delivery fee for each customer group individually. Cash on delivery amount, declared value amount, and CARD payment type are used in service percent calculations set up in the delivery rate card, on the '''Other''' tab. 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.

In authorization login and pass parameters can be omitted, then calculation will be made according to a standard tariff rate of a delivery service with no account of possible differences for a certain customer. <br>The name of a town (not recommended!), or its code from our listDimensional weight is calculated only if all the dimensions are provided: length, or its 13-digit code of All-Russian Classifier of Addresses (Address Classifier used in Russia)width, or its 36-digit code of the Federal Information Address System (AOID) can be entered into the fields for a sending town and a receiving townheigth.

'''The example of a cost of delivery response:Response Example'''

<servicename="Express">1</service>

<price>11631113</price> <mindeliverydays>1</mindeliverydays>

*'''townfrom''' is a sending town name which has been — sender location as recognized and assigned to the list of towns cities by the system. **'''code''' attribute is — a code from the '''City Names''' list of towns in the system.*'''townto''' is a receiving town name which has been — recipient location as recognized and assigned to the list of towns cities by the system. **'''code''' attribute is — a code from the '''City Names''' list of towns in the system.*'''mass''' is — weight in kilograms. *'''service''' is a — delivery mode - a number indicating the entry in the list of [The list of types of priority|types of priority]*which is an integer specifying an '''serviceUrgency Kinds''' list record. If the parameter is not specified, all available urgency kinds are calculated, with a delivery mode - lot of the number indicating a certain entry <calc> containers in the list of types of priority (See the description on this page)response. *'''zone''' is the — number of a tariff the rate zone according to which used in the price has been calculatedcalculation. The tariff shipping rate schedule is selected depending on the tariff zone. Multiplying or decreasing coefficients Coefficients can be applied to the price of delivery in case of shipping cost if the order delivery is not delivered from/or to a regional center. *'''price''' is a calculated delivery price — shipping cost in the currency of a the courier service. We recommend that you use this parameter. *'''maxdeliverydays''' — maximum number of busines days in transit.*'''mindeliverydate''' — closest delivery service`s date considering holidays.*'''deliveryprice''' — contains shipping cost details. '''Note''': the actual server response contains the <code>price-list</code> attribute in the <code>calc</code> tag. It is recommended to be used rather than its homonymous attribute of the parent 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. *'''maxdeliverydaysauth''' — authorization. Required. '''Response Example'''<source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><client> <code>1082</code></client></source> *'''code''' is the maximum delivery period in business days— client code.

== The list List of money transfer certificates Сash Transfer Certificates ==

'''The example of the query for the list of money transfer certificates:Request Example'''

<datefrom>20162021-02-10</datefrom> <dateto>20162021-03-10</dateto>

'''smalist''' is a — root container. It is a mandatory elementRequired. *'''auth''' is — authorization. It is a mandatory elementRequired. *'''datefrom''' is a — date “from”from. It is an optional elementOptional. *'''dateto''' is a — date “to”to. It is an optional elementOptional.

If the date range is not specified, then money cash transfer certificates for the last month are returned.

'''The example of a response to the query for the list of money transfer certificates:Response Example'''

<actdate>20162020-02-12</actdate>

*'''code''' is a code of a money — cash transfer certificatecode. *'''number''' is the number of a money — cash transfer certificate number in the systemMeaSoft. *'''actdate''' is a — date of a money cash transfer certificatecreated.*'''datepay''' is a — date of payment on a money cash transfer certificate paid. *'''dateto''' — cash transfer certificateperiod end date.*'''promiseddatepay''' — planned payment date. *'''price''' is a price — cost of courier services. *'''pricecorr''' — adjustment amount.*'''rur''' is a price of an — orderamount. *'''pricekur''' is a price of — courier deliverycost. *'''priceag''' is agent`s commission— service partner fee. *'''payno''' is a number of a — payment ordernumber. *'''paytype''' is a — type of payment: 1 — non-cash payment, 2 — paying a courier in cash, 3 — paying cash at the office, 4 — wire payment to bank card.*'''paytypename''' — payment type as string.*'''signedcopyreceived''' — indicates whether cash transfercertificate is returned. Possible values: '''YES''', '''NO'''.

== Detailing of money transfer certificates Cash Transfer Certificate Breakdown ==

'''The examples of the query for money transfer certificates detailing:Request Example'''

'''smadetail''' is a — root container. It is a mandatory elementRequired. *'''auth''' is — authorization. It is a mandatory elementRequired.*'''code''' is a code of a money — cash transfer certificate (See the query [[#List of the list of money transfer certificates)Сash Transfer Certificates|code]]. It is a mandatory elementRequired.

'''The example of a response to the query of money transfer certificates:Response Example'''

<smadetail count="12">

<addresscodeordercode>14424</addresscodeordercode> <orderno>11111</orderno> <orderdate>2021-01-01</orderdate> <delivereddate>2021-10-01</delivereddate> <company>Company</company>

<paytype>Cash on delivery2</paytype> <statuspaytypename>Deliveredpaying a courier in cash</status> </specialsma> <specialsma> <code>42495</code> <addresscode>14415</addresscode> <price>323.00</price> <rur>4630.00</rurpaytypename> <pricekurweight>3000.00400</pricekurweight> <priceagdistance>230.000</priceag> <pricecalc>4306.00</pricecalc> <paytype>Cash on delivery</paytypedistance>

*'''code''' is a — record code of the record. *'''addresscodeordercode''' is a — external order code of the .*'''orderno''' — order cipher.*'''orderdate''' — orderdate.*'''delivereddate''' — delivery date.*'''company''' — recipient. *'''price''' is a price — cost of service courier services.*'''rur''' is the — order amount of the .*'''inshprice''' — ordercost. *'''pricekur''' is a price of — courier deliverycost. *'''priceag''' is agent`s commission— service partner fee. *'''pricecalc''' is the — amount to be transferred pay to the agentservice partner. *'''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— payment to bank card.*'''paytypename''' — payment type as string.*'''weight''' — order weight.*'''distance''' — order distance. *'''status''' is a — order status of the order.

== Generation of short links URL Shortener ==

In some casesSometimes, for you might want to use short links to client account. For instance, when using them in sending an SMS, the use of short links to member area may be requiredrecipient.

For doing that it is necessary to To get a short URL, send a query containing request with a full link to which a response containing a hash code URL. Hash value for a short link will be sentis returned.

'''The example of a query for short links generation:Request Example'''

'''shortlink''' is a — root container. It is a mandatory elementRequired.*'''link''' is a full — long link for generation of which a code should be obtainedto shorten. It is a mandatory elementRequired. If '''short''' attribute equals value is '''1''', then a response won`t contain XML but the return contains only a hash code, no XML.

'''The example of a response to the query for short links generation:Response Example'''

*'''hash''' is a — URL hash code of a short link. Use it as client account URL: <nowiki>https://home.courierexe.ru/35AF350C or curie.ru/35AF350C</nowiki> '''Note'''. URL shortener is only for MeaSoft company sites. == Recipient Rating Check == The check is available only for the Maximum personal account plan. '''Request Example''' <source lang="xml"><?xml version="1.0" encoding="UTF-8" ?><mcheck> <auth extra="8" login="login" pass="pass" /> <phones> <phone>89161147992</phone> </phones></mcheck></source>

<nowikisource lang="xml">https:<?xml version="1.0" encoding="UTF-8" ?><mcheck> <phones> <phone rate="90">89161147992</phone> </home.courierexe.ruphones></35AF350Cmcheck></nowikisource>