Изменения

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

API Documentation

2731 байт добавлено, 14:11, 29 июля 2021
м
Delivery cost calculation
</source>
== Delivery cost calculation Additional 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 additional services available in client account are returned. Optional. Possible values: '''Yes''', '''No'''. The example default value is '''No'''.  '''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 '''Additional Services''' list the '''Name in client account''' column is not empty, the column value is returned.*'''hine''' — additional 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'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<calc pricetype="CUSTOMER" townfrom="Moscow" addressfrom=" Lenin prospect, 95" zipcode="664000" townto="3800000300000" addressto="Pushkinskaya str., 10" pvz="123" l="10" w="20" h="30" mass="3.7" service="1" price="1200" inshprice="1200" paytype="CASH" />
</calculator>
</source>
Parameters:
*'''townfrom''' is a sending town.
*'''townto''' is a receiving town.
*'''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]
'''Fields Description''' *'''pricetype''' — price type. Possible values:** '''CUSTOMER''' — price for customer. The default value.** '''CLIENT''' — courier service price for client.*'''townfrom''' - sender location.*'''addressfrom''' — sender address.*'''zipcode''' — recipient postal code.*'''townto''' — 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''' — weight in kg.*'''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.*'''price''' — cash on delivery amount.*'''inshprice''' — declared value amount.*'''paytype''' — payment type. 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 parameters can be omitted'''. In this case, then calculation will be made according to a the fee is calculated using courier service standard tariff delivery rate of a delivery service with no , without taking into account of possible differences for a certain customerclient. <br>The name of a town (not recommended!)Dimensional weight is calculated only if all the dimensions are provided: length, or its code from our listwidth, or its 13-digit code of All-Russian Classifier of Addresses (Address Classifier used in Russia), 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.
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).
'''The example of a cost of delivery response:Response Example'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townto code="56603">Irkutsk city</townto>
<mass>3.7</mass>
<servicename="Express">1</service>
<zone>2</zone>
<price>1163</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>
</deliveryprice>
</calc>
</calculator>
Parameters:
*'''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 delivery the courier service`s price-list. It is recommended to be used rather than its homonymous attribute of the parent containerWe recommend that you use this parameter. *'''maxdeliverydays''' is the maximum number of busines days in transit.*'''mindeliverydate''' — closest delivery period in business daysdate considering holidays.*'''deliveryprice''' — contains shipping cost details.
== The list of money transfer certificates ==

Навигация