2651
правка
Изменения
м
Нет описания правки
=== Order Elements ===
*'''neworder''' is a root container, a mandatory elementrequired.
:*'''''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, a mandatory elementrequired. 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 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.
</source>
* '''receiver''' is the information about the recipient. It is a mandatory containerRequired.
<source lang="xml">
<receiver>
=== Fields Description ===
'''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 — the default value.
'''Query Fields'''
* '''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''' — the default value.
'''The description of status response fields:'''
'''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 attributes:
:* '''''ordercode''''' is an internal code of an order.
:* '''''date''''' is status change date.
'''The fields description:'''
'''waybill''' - is a root container. It is a mandatory elementRequired. *'''auth''' - is authorization. It is a mandatory elementRequired. *'''orderno''' - Order number. It is a mandatory elementRequired. *'''form''' - Form type. Is not mandatoryOptional. Can It can be:
:* 1 - A detailed waybill
:* 2 - Sticker (Zebra)
'''The description of status query fields:'''
'''cancelorder''' is a root container. It is a mandatory elementRequired. *'''auth''' is authorization. It is a mandatory elementRequired.*'''order''' is a cancelled order container. It is a mandatory elementRequired. 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.
</source>
'''smalist''' is a root container. It is a mandatory elementRequired. *'''auth''' is authorization. It is a mandatory elementRequired. *'''datefrom''' is a date “from”. It is an optional elementOptional. *'''dateto''' is a date “to”. It is an optional elementOptional.
If the date range is not specified, then money transfer certificates for the last month are returned.
</source>
'''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 transfer certificate (See the query of the list of money transfer certificates). It is a mandatory elementRequired.
'''The example of a response to the query of money transfer certificates:'''
</source>
'''shortlink''' is a root container. It is a mandatory elementRequired.*'''link''' is a full link for generation of which a code should be obtained. It is a mandatory elementRequired. If '''short''' attribute equals 1, then a response won`t contain XML but only a hash code.
'''The example of a response to the query for short links generation:'''
