Обновить задание на доставку

/api/v1/delivery/tasks/{id}

PUT

https://secured-openapi.tbank.ru/api/v1/delivery/tasks/{id}

Метод позволяет обновить уже созданное задание по его ID. Если вызов успешный, в ответе возвращается ошибка или пустой объект.

Чтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/update — Обновление задания на доставку.

Авторизация

Security

Bearer API Token

MTLS-сертификат

Запрос

Path parameters

Required

id

String

Идентификатор задания.

Request body schema application/json

Required

template

String

Шаблон, определяющий бизнес-логику задания.

commentForAgent

String

Комментарий к заданию для представителя.

parentTaskId

String

Идентификатор родительского задания.

meta

Object

Дополнительные метаданные в формате JSON.

property name*

String

contacts

Array of objects ()

Группа объектов с информацией о данных каждого участника задания, подлежащего удостоверению на встрече.

Required

id

String

Уникальный идентификатор контакта.

role

String

Роль.

firstName

String

Имя.

lastName

String

Фамилия.

middleName

String

Отчество.

birthDate

String<date>

Дата рождения.

phones

Array of objects ()

Телефон.

Required

type

String (PhoneType2)

Requirements: [MOBILE, HOME, WORK, OTHER]

Тип телефона

Required

number

String

Requirements: Value must match regular expression ^((\+7)([0-9]){10})$

Номер телефона в формате +7xxxxxxxxxx

documents

Array of objects ()

Документы, удостоверяющие личность. Для роли REALTOR параметр можно не передавать.

oneOf

Passport2

Required

type

String (IdentificationDocumentType)

Requirements: [PASSPORT]

Тип документа

Required

number

String

Номер документа

Required

series

String

Серия документа

divisionName

String

Подразделение

issueDate

String<date>

Дата выдачи документа

photos

Array of objects ()

Группа объектов с информацией о фото, относящихся к заданию.

Required

id

String

type

String

Тип фото.

subType

String

Подтип фото.

sheetNumber

Integer<int32>

Номер страницы.

review

Object

Результат проверки фото в формате JSON.

property name*

String

Ответ

200

OK

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Получить консультацию по интеграции

Пример запроса

Payload

cURL

Go

Java

NodeJs

PHP

Python

Content type

application/json

{

"template":

"PartnerDelivery",

"commentForAgent":

"Проверить паспорт",

"parentTaskId":

"39df83a3-edc7-4c83-ba53-9eaae38c225f",

"meta": {

"dealNumber":

"456793"

},

"contacts": [

{ ... }

"id":

"39df83a3-edc7-4c83-ba53-9eaae38c225f",

"role":

"Риэлтор",

"firstName":

"Иван",

"lastName":

"Иванов",

"middleName":

"Иванович",

"birthDate":

"1990-05-05",

"phones": [

{

"type":

"MOBILE",

"number":

"+79546523687"

}

],

"documents": [

{ ... }

"type":

"PASSPORT",

"number":

"123467",

"series":

"3456",

"divisionName":

"УВД Раменского района",

"issueDate":

"1990-05-05"

}

]

}

],

"photos": [

{

"id":

"39df83a3-edc7-4c83-ba53-9eaae38c225f",

"review": {

"status":

"ACCEPTED"

}

},

{

"id":

"39df83a3-edc7-4c83-ba53-9eaae38c225f",

"review": {

"status":

"DISCARDED",

"decisionReason": [

"все очень плохо",

"могло бы быть и лучше"

]

}

}

]

}

Пример ответа

200

400

401

403

422

429

500

Content type

application/json

Request does not contain a response