Подтверждение доставки

Возвращает данные, подтверждающие доставку.

В ответе можно получить идентификаторы точек на маршруте, фотографии, сделанные курьером на этих точках, и имена получателей

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/proof-of-delivery/info

Адрес сервиса

Query parameters

Name

Description

claim_id

Type: string

ID заявки, полученный на этапе создания заявки

Min length: 32

Max length: 64

Example: ``

Headers

Name

Description

Accept-Language

Type: string

Предпочитаемый язык ответа

Например:
ru — русский
en — английский

Example: ru

Responses

200 OK

Body

application/json

{
  "proof_of_delivery_info": [
    {
      "claim_point_id": 372036854775807,
      "photos": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "claim_point_id": null,
          "url": "example",
          "status": "initiated",
          "external_id": "example"
        }
      ],
      "recipient_info": {
        "recipient_name": "example",
        "recipient_type": "example",
        "document_id": "example"
      }
    }
  ]
}

Name

Description

proof_of_delivery_info

Type: ProofOfDeliveryInfo[]

Example

[
  {
    "claim_point_id": 372036854775807,
    "photos": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "claim_point_id": null,
        "url": "example",
        "status": "initiated",
        "external_id": "example"
      }
    ],
    "recipient_info": {
      "recipient_name": "example",
      "recipient_type": "example",
      "document_id": "example"
    }
  }
]

ClaimPointId

Целочисленный идентификатор точки (int64), генерируемый
на стороне Яндекс Доставки.
Содержится в поле route_points[].id. Применимо к точкам с типом
source, destination, return.

Type: integer

UploadStatusType

Статус загрузки

Type: string

Enum: initiated, uploaded, mds_failed, validated, validation_failed

Photo

Фотографии, подтверждающие доставку

Name	Description
claim_point_id	Type: ClaimPointId Указание, в какой точке сделана фотография Целочисленный идентификатор точки (int64), генерируемый на стороне Яндекс Доставки. Содержится в поле route_points[].id. Применимо к точкам с типом source, destination, return. Example: `372036854775807`
id	Type: string<uuid> Уникальный идентификатор фотографии. Example: `123e4567-e89b-12d3-a456-426614174000`
status	Type: UploadStatusType Статус загрузки Enum: `initiated`, `uploaded`, `mds_failed`, `validated`, `validation_failed`
url	Type: string URL для загрузки фотографий Example: `example`
external_id	Type: string внешний ID Example: `example`

Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "claim_point_id": 372036854775807,
  "url": "example",
  "status": "initiated",
  "external_id": "example"
}

RecipientInfo

Информация о получателе товара

Name	Description
recipient_name	Type: string Имя получателя Example: `example`
recipient_type	Type: string Кем является фактический получатель по отношению к получателю, указанному в заявке Example: `example`
document_id	Type: string Номер документа, подтверждающего доставку Example: `example`

Example

{
  "recipient_name": "example",
  "recipient_type": "example",
  "document_id": "example"
}

ProofOfDeliveryInfo

Name	Description
claim_point_id	Type: ClaimPointId Целочисленный идентификатор точки (int64), генерируемый на стороне Яндекс Доставки. Содержится в поле route_points[].id. Применимо к точкам с типом source, destination, return. Example: `372036854775807`
photos	Type: Photo[] Example `[ { "id": "123e4567-e89b-12d3-a456-426614174000", "claim_point_id": 372036854775807, "url": "example", "status": "initiated", "external_id": "example" } ]`
recipient_info	Type: RecipientInfo Информация о получателе товара Example `{ "recipient_name": "example", "recipient_type": "example", "document_id": "example" }`

Example

{
  "claim_point_id": 372036854775807,
  "photos": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "claim_point_id": null,
      "url": "example",
      "status": "initiated",
      "external_id": "example"
    }
  ],
  "recipient_info": {
    "recipient_name": "example",
    "recipient_type": "example",
    "document_id": "example"
  }
}

404 Not Found

Заявка не найдена или информация по заявке не найдена

Body

application/json

{
  "code": "not_found",
  "message": "Заявка не найдена"
}

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, not_found

message

Type: string

Описание ошибки

Example: Заявка не найдена

Была ли статья полезна?

3. Код подтверждения

5.1 До подтверждения