Поиск по сайту

API
Главная / API - Changing the order payer data

Changing the order payer data

Обновлено 20.05.2022
106 кб

General information 

The service allows changing the payer for an already placed order. To change the payer it is necessary to have full access to the sender or to the new payer (see "Available counterparties" method, response parameter "info.accessLevel"). 

To change the recipient for the order and appointing the new recipient as the payer, use "Changing the order receiver data" method.

To check the possibility of changing the payer, 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 payer data

Method request

Request structure

Method address: https://api.dellin.ru/v3/orders/change_payer.json 

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"00000000",
   "counteragentUID":"0x8f51001438c4d49511dbd774581edb7a",
   "docUID": "0x81870050568388af11ea718b63f47df1",
   "contactIDs":[
      12345678,
      78456123
   ],
   "contactPersons":[
      {
         "name":"Иван Иванович"
      },
      {
         "name":"Петр Петрович"
      }
   ],
   "phoneIDs":[
      98765412,
      65478921
   ],
   "phoneNumbers":[
      {
         "number":"79213332211",
         "ext":"0123"
      }
   ],
   "dataForReceipt":{
      "phone":"+79999999999",
      "email":"test@mail.ru"
   }
}

Method address: https://api.dellin.ru/v3/orders/change_payer.xml

<request>
  <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>00000000</orderID>
   <counteragentUID>0x8f51001438c4d49511dbd774581edb7a</counteragentUID>
   <docUID>0x81870050568388af11ea718b63f47df1</docUID>
   <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>
   <dataForReceipt>
      <phone>+79999999999</phone>
      <email>test@mail.ru</email>
   </dataForReceipt>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription

appkey

YesstringApplication key. To get the key, register
sessionIDYesstringSession ID. To get the session ID, use "User authorization" service

orderID

YesstringThe number of the order for which it is necessary to change the payer

counteragentUID

Yesstring

Counterparty UID (see "Available counterparties" method)

The current account should have full access to the sender or the new payer (see "Available counterparties" method, response parameter "info.accessLevel")
docUIDNo*string

Waybill UID.

*The parameter is required if several waybill were created for the order

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

YesstringContact 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

YesstringPhone number. 15 digits maximum

phoneNumbers.ext

NostringExtension phone number. 5 digits maximum

dataForReceipt

Noobject

Contact data to send the payment receipt to the individual. The parameter is used only for individuals

dataForReceipt.phoneNo*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.emailNo*string

Email address for sending the payment receipt. 128 characters maximum

*At least one of the following parameters is required: "dataForReceipt.phone", "dataForReceipt.email"

Method response

Response structure

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-18 12:52:26"
   },
   "data":{
      "status":"success"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-18 12:52:26</generated_at>
   </metadata>
   <data>
      <status>success</status>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusinteger

Emulated status http-code. If successful, code 200 is returned. In case of error - 400

metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataobjectSuccess confirmation
data.statusstring

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 

Error handling

Except for common API errors the method response may contain the following errors:

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation

611001

400По данному заказу изменение плательщика недоступноThe payer for the order can not be changed--

611002

400По данному заказу изменение плательщика недоступноThe payer for the order can not be changedИзменение по данному заказу недоступно в связи с отсутствием доступаIt is not possible to change the order details since there is no access

611003

400Необходимо указать накладнуюPlease indicate the waybill number--

611004

400Данная накладная уже оплаченаThe payment on the waybill has been already made--