Changing the order receiver data
General information
The service allows changing the recipient for an already placed order, if necessary appointing the new recipient as the payer for the order, as well as determining who will incur the costs of the paid storage - the sender, the new recipient or a third party.
Only sender or a user with the full access to the sender-counterparty can change the receiver (for more information on full access see "Available counterparties" method, the description of info.accessLevel parameter). To check the possibility of changing the recipient, use "Checking possibility to change the order" method.
The changes do not come into effect immediately. After further verification the request can be approved or declined. To check the change request status use "Change history" method.
Changing the order receiver data
Method request
Request structure
Method address: https://api.dellin.ru/v3/orders/change_receiver.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"00000000", "receiver":{ "counteragentID":456783515, "counteragent":{ "form":"0x8F51001438C4D49511DBD774581EDB80", "document":{ "type":"passport", "serial":"1111", "number":"123456" }, "inn":1234567890, "name":"Ромашка", "juridicalAddress":{ "search":"Омская обл., Омск, Ленина, 5", "street":"5500000100005970000000000", "house":"5", "building":"1", "structure":"3А", "flat":"Б-234" } }, "contactIDs":[ 12345678, 78456123 ], "contactPersons":[ { "name":"Иван Иванович" }, { "name":"Петр Петрович" } ], "phoneIDs":[ 98765412, 65478921 ], "phoneNumbers":[ { "number":"79213332211", "ext":"0123" } ], "email":"test@mail.ru", "dataForReceipt":{ "phone":"+79999999999", "email":"test@mail.ru" } }, "changeOrderPayer":true, "storePayer":"third", "third":{ "counteragentID":456783515, "counteragent":{ "form":"0x8F51001438C4D49511DBD774581EDB80", "document":{ "type":"passport", "serial":"1111", "number":"123456" }, "inn":1234567890, "name":"Ромашка", "juridicalAddress":{ "search":"Новосибирская обл., Новосибирск, Кутузова, 5", "street":"5400000100019470000000000", "house":"5", "building":"2", "structure":"3А", "flat":"Б-234" } }, "contactIDs":[ 12345678, 78456123 ], "contactPersons":[ { "name":"Иван Иванович" }, { "name":"Петр Петрович" } ], "phoneIDs":[ 98765412, 65478921 ], "phoneNumbers":[ { "number":"79213332211", "ext":"0123" } ], "email":"test@mail.ru", "dataForReceipt":{ "phone":"+79999999999", "email":"test@mail.ru" } } }
Method address: https://api.dellin.ru/v3/orders/change_receiver.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>00000000</orderID> <receiver> <counteragentID>456783515</counteragentID> <counteragent> <form>0x8F51001438C4D49511DBD774581EDB80</form> <document> <type>passport</type> <serial>1111</serial> <number>123456</number> </document> <inn>1234567890</inn> <name>Ромашка</name> <juridicalAddress> <search>Омская обл., Омск, Ленина, 5</search> <street>5500000100005970000000000</street> <house>5</house> <building>1</building> <structure>3А</structure> <flat>Б-234</flat> </juridicalAddress> </counteragent> <contactIDs>12345678</contactIDs> <contactIDs>78456123</contactIDs> <contactPersons> <name>Иван Иванович</name> </contactPersons> <contactPersons> <name>Петр Петрович</name> </contactPersons> <phoneIDs>98765412</phoneIDs> <phoneIDs>65478921</phoneIDs> <phoneNumbers> <number>79213332211</number> <ext>0123</ext> </phoneNumbers> <email>test@mail.ru</email> <dataForReceipt> <phone>+79999999999</phone> <email>test@mail.ru</email> </dataForReceipt> </receiver> <changeOrderPayer>true</changeOrderPayer> <storePayer>third</storePayer> <third> <counteragentID>456783515</counteragentID> <counteragent> <form>0x8F51001438C4D49511DBD774581EDB80</form> <document> <type>passport</type> <serial>1111</serial> <number>123456</number> </document> <inn>1234567890</inn> <name>Ромашка</name> <juridicalAddress> <search>Новосибирская обл., Новосибирск, Кутузова, 5</search> <street>5400000100019470000000000</street> <house>5</house> <building>2</building> <structure>3А</structure> <flat>Б-234</flat> </juridicalAddress> </counteragent> <contactIDs>12345678</contactIDs> <contactIDs>78456123</contactIDs> <contactPersons> <name>Иван Иванович</name> </contactPersons> <contactPersons> <name>Петр Петрович</name> </contactPersons> <phoneIDs>98765412</phoneIDs> <phoneIDs>65478921</phoneIDs> <phoneNumbers> <number>79213332211</number> <ext>0123</ext> </phoneNumbers> <email>test@mail.ru</email> <dataForReceipt> <phone>+79999999999</phone> <email>test@mail.ru</email> </dataForReceipt> </third> </request>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appkey | Yes | string | Application key. To get the key, register |
sessionID | Yes | string | Session ID. To get the session ID, use "User authorization" service |
orderID | Yes | string | The number of the order for which it is necessary to change the receiver |
receiver | Yes | Member | New receiver info |
changeOrderPayer | Yes | boolean | Flag indicating that the new receiver should be designated as the payer. Possible values:
|
storePayer | Yes | string | Party that incurs the cost of paid storage. Possible values:
|
third | No* | Member | Third party info. *If "storePayer" parameter value is "third" then the parameter "third" is required |
Member
Member | |||
---|---|---|---|
Parameter | Required | Type | Description |
counteragentID | No* | integer | Counterparty ID from "Address book". *One of the following excluding parameters is required: "counteragentID" or "counteragent" |
counteragent | No* | Counteragent | Counterparty info *One of the following excluding parameters is required: "counteragentID" or "counteragent" |
contactIDs | No* | array of integers | Contact persons IDs from "Address book". Maximum 3 elements in the array. *One of the following excluding parameters is required: "contactIDs" or "contactPersons" |
contactPersons | No* | array of contactPersons | Contact persons data. Maximum 3 elements in the array. *One of the following excluding parameters is required: "contactIDs" or "contactPersons" |
contactPersons.name | Yes | string | Contact person name |
phoneIDs | No* | array of integers | Phone number IDs from "Address book". Maximum 3 elements in the array. *One of the following excluding parameters is required: "phoneIDs" or "phoneNumbers" |
phoneNumbers | No* | array of phoneNumbers | Phone numbers list. Maximum 3 elements in the array. *One of the following excluding parameters is required:"phoneIDs" or "phoneNumbers" |
phoneNumbers.number | Yes | string | Phone number. Maximum15 digits |
phoneNumbers.ext | No | string | Extension phone number. Maximum 5 digits |
No | string | Ordering customer email. Maximum 128 characters | |
dataForReceipt | No | object | Contact data to send the payment receipt to the individual. The parameter is used in the following cases:
|
dataForReceipt.phone | No* | string | Phone number for sending the payment receipt, required format: "+79XXXXXXXXX" (where X is any digit). *At least one of the following parameters is required: "dataForReceipt.phone", "dataForReceipt.email" |
dataForReceipt.email | No* | string | Email address for sending the payment receipt. Maximum 128 characters. *At least one of the following parameters is required: "dataForReceipt.phone", "dataForReceipt.email" |
Counteragent
Counteragent | |||
---|---|---|---|
Parameter | Required | Type | Description |
form | Yes | string | UID of legal form of organization, see "Search of forms of organization" |
document | No* | object | Personal ID data. The parameter is used only for individuals (that is when an individual UID is passed in the "form" parameter). *If the counterparty is an individual, the parameter is required |
document.type | Yes | string | Document type. Possible values:
|
document.serial | Yes* | string | Document series *For some countries the parameter is not required and therefore ignored |
document.number | Yes | string | Document number. Number format may vary depending on the country |
inn | No* | integer | TIN (taxpayer identification number). Allowed number of characters may vary depending on country and legal form of organization. The parameter is used for legal entities only (that is when legal entity UID is passed in the "form" parameter). *If the counterparty is a legal entity, the parameter is required |
name | Yes | string | Individual or company name |
juridicalAddress | No | Address | Legal address. The parameter is used for legal entities only (that is when legal entity UID is passed in the "form" parameter) |
Address
Address | |||
---|---|---|---|
Parameter | Required | Type | Description |
search | No* | string | Address as text. The coordinates should not be used to pass the information about the juridical address. When passing an address as text, the request should include:
The address elements should be separated by comma, for example "Омская обл., Омск, Ленина, 5". Minimum 2 characters, maximum 1024 characters *Passing the "search" parameter or a pair of "street" and "house" parameters is required. The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive |
street | No* | string | CLADR* code of the street (see. "CLADR search"). *CLADR - Classifier of Addresses of Russian Federation *Passing the "search" parameter or a pair of "street" and "house" parameters is required. The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive |
house | No* | string | House number, including the letter. For example, "13/A". Maximum 7 characters *Passing the "search" parameter or a pair of "street" and "house" parameters is required. The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive |
building | No | string | Building. Maximum 5 characters The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive |
structure | No | string | Structure. Maximum 7 characters The "search" parameter and the "street", "house", "building" and "structure" parameter set are mutually exclusive |
flat | No | string | Apartment/office, including the letter. For example, "222 A". Maximum 5 characters *If “search” and “flat” parameters are both passed in the request, then the value of the “flat” parameter will be used as the apartment/office number |
Method response
Response structure
{ "metadata":{ "status":200, "generated_at":"2019-11-18 12:52:26" }, "data":{ "status":"success", "foundAddresses":[ { "field":"receiver.counteragent.juridicalAddress", "source":"Омская обл., Омск, Ленина, 5", "result":"Россия, Омская обл, г Омск, ул Ленина, д 5" }, { "field":"third.counteragent.juridicalAddress", "source":"Новосибирская обл., Новосибирск, Кутузова, 5", "result":"Россия, Новосибирская обл, г Новосибирск, ул Кутузова, д 5" } ] } }
<response> <metadata> <status>200</status> <generated_at>2019-11-18 12:52:26</generated_at> </metadata> <data> <status>success</status> <foundAddresses> <field>receiver.counteragent.juridicalAddress</field> <source>Омская обл., Омск, Ленина, 5</source> <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result> </foundAddresses> <foundAddresses> <field>third.counteragent.juridicalAddress</field> <source>Новосибирская обл., Новосибирск, Кутузова, 5</source> <result>Россия, Новосибирская обл, г Новосибирск, ул Кутузова, д 5</result> </foundAddresses> </data> </response>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | System information |
metadata.status | integer | Emulated status http-code. If successful, code 200 is returned. In case of error - 400 |
metadata.generated_at | string | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
data | object | Success confirmation |
data.status | string | Status in English. Possible value - "success" "Success" status indicates that the request was accepted. After further verification the request can be approved or declined. To check the change request status use "Change history" method |
data.foundAddresses | array of FoundAddresses | Data on found addresses. The parameter is present in the response if "juridicalAddress.search" parameter of the Counteragent class was passed in the request |
FoundAddresses
FoundAddresses | ||
---|---|---|
Parameter | Type | Description |
field | string | The parent object that was used to pass the "search" parameter |
source | string | Entered value |
result | string | Address found |
Error handling
Except for common API errors the method response may contain the following errors:
Error number | http-code | Error title | Error description | ||
---|---|---|---|---|---|
Title | Translation | Description | Translation | ||
610001 | 400 | По данному заказу изменение получателя недоступно | The receiver for the order can not be changed | - | - |
610002 | 400 | По данному заказу изменение получателя недоступно | The receiver for the order can not be changed | Изменение по данному заказу недоступно в связи с отсутствием доступа | It is not possible to change the order details since there is no access |
610003 | 400 | Указан анонимный контрагент | "Anonymous" counteragent indicated | Данная операция невозможна для контрагента анонима | The operation is not available for an "anonymous" counteragent |
610014 | 400 | Ошибка наложенного платежа | Cash on delivery error | Получателем в заказе с наложенным платежом может быть только физическое лицо | Cash on delivery payment is only possible if the receiver is an individual (not a legal entity) |