Изменения

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

API Documentation

1760 байт добавлено, 15:26, 2 июля 2021
м
Changing Order
== Changing Order ==
The request is intended to edit the orders that are not in process yet — there was no changes of shipment or delivery status or delivery time, etc.
You can only edit orders if the courier service uses the Premium or Maximum [[Courier Service Account#Personal Account Functions|personal account plan]]. To enable order editing, in the courier service account go to '''Settings''' > '''Parameters''' > '''Advanced''' and select the '''Allow canceling and editing orders''' check box.
<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
All response fields correspond to the [[#Creating Order|order creating responce structure]], except for:
*the <code>editorder</code> tag is returned instead of <code>neworder</code>.
 
== Canceling Order ==
 
The request is intended to cancel the orders that are not in process yet — there was no changes of shipment or delivery status or delivery time, etc.
 
You can only cancel orders if the courier service uses the Premium or Maximum [[Courier Service Account#Personal Account Functions|personal account plan]]. To enable order canceling, in the courier service account go to '''Settings''' > '''Parameters''' > '''Advanced''' and select the '''Allow canceling and editing orders''' check box.
 
Once an order is canceled, the '''Delivery info''' field is filled in with '''Canceled by client''', the '''Delivery date''' is filed in with the current date, the '''Delivered by''' is filled in with system entry CANCEL.
 
'''Order Cancelation Example'''
 
<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>
 
'''Status Request Fields'''
 
'''cancelorder''' — root container. It is a mandatory element.
* '''auth''' — authorization. It is a mandatory element.
* '''order''' — container of the order being canceled. It is a mandatory element. The request can contain more than one '''order'''. It has the following attributes:
:* '''''orderno''''' — order number.
:* '''''ordercode''''' — internal order number.
Either ''orderno'' or ''ordercode'' is required.
 
'''Response Example'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<order orderno="123test" ordercode="123456" error="0" errormsg="OK" />
<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" />
</cancelorder>
</source>
== Status change by agent ==

Навигация