Изменения

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

API Documentation

7310 байт добавлено, 15:16, 28 июля 2021
м
The list of order points of issue
*'''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 Item Movement ==
 
'''Request Example'''
<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>
 
*'''code''' — internal item code in the list of goods.
*'''datefrom''' — period start date.
*'''dateto''' — period end date.
You can specify either code or period, or both code and period.
 
 
'''Response Example'''
<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.
*'''retprice''' — item price.
*'''quantity''' — item quantity in the movement transaction.
*'''delivered''' — quantity of delivered items.
 
*'''item''' — goods item container.
:* '''code''' — item internal code.
:* '''name''' — item name.
 
*'''status''' — transaction status container.
:* '''code''' — status code.
:* '''name''' — name.
 
*'''store''' — container for the branch that performs the transaction.
:* '''code''' — branch code.
:* '''name''' — branch name.
 
*'''order''' — shipment container.
:* '''ordercode''' — internal order code.
:* '''number''' — order number.
:* '''date''' — order date.
:* '''orderno''' — order code.
:* '''barcode''' — barcode.
:* '''company''' — company.
:* '''address''' — address.
:* '''delivereddate''' — date delivered.
:* '''deliveredtime''' — time delivered.
:* '''deliveredto''' — delivery info or reason for non-delivery.
 
*'''document''' — transaction document container.
:* '''code''' — internal document code.
:* '''number''' — document number.
:* '''extnumber''' — external document number.
:* '''date''' — document date.
:* '''message''' — comment.
 
== Getting Shipping Rates for Towns and Cities ==
 
'''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.
 
 
'''Response Example'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562",
"towntocode": "482",
"towntoname": "Ufa city",
"pricesnew": {
"before": [
{
"price": "100",
"every": "0",
"mass": "1"
},
{
"price": "200",
"every": "1",
"mass": "2"
}
],
"after": [
{
"price": "300",
"every": "1",
"mass": "3"
}
]
},
"prices": {
"before": {
"mass": "3",
"price": "202.5"
},
"after": {
"mass": "3",
"every": "1",
"price": "18.75"
}
},
"deliveryPeriodMin": 4,
"deliveryPeriodMax": 5
}
]
}
</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.
:* '''pricesnew''' — your shipping rates from the '''Inter-city''' > '''Rates by Zones''' table.
::* '''price''' — price.
::* '''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.
== The list of order points of issue ==

Навигация