Confirm delivery

Returns the data confirming delivery.

The response may contain IDs of points on the route, photos taken by the courier at those points, and recipient names

Request

POST

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

Service URL

Query parameters

Name

Description

claim_id*

Type: string

Claim ID received at the claim creation stage

Min length: 32

Max length: 64

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English

Example: en

Responses

200 OK

OK

Body

application/json
{
    "proof_of_delivery_info": [
        {
            "claim_point_id": 372036854775807,
            "photos": [
                {
                    "id": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
                    "claim_point_id": 372036854775807,
                    "url": "string",
                    "status": "initiated",
                    "external_id": "string"
                }
            ],
            "recipient_info": {
                "recipient_name": "string",
                "recipient_type": "string",
                "document_id": "string"
            }
        }
    ]
}

Name

Description

proof_of_delivery_info*

Type: ProofOfDeliveryInfo[]

ProofOfDeliveryInfo

Name

Description

claim_point_id*

Type: integer<int64>

Integer point ID (int64) generated
on the Yango Delivery side.
It is in the route_points[].id field. Applicable to
source, destination, and return points.

Example: 372036854775807

photos

Type: Photo[]

Photos confirming the delivery

recipient_info

Type: RecipientInfo

Information about the recipient of the item

Photo

Photos confirming the delivery

Name

Description

claim_point_id*

Type: integer<int64>

Indication of where the photo was taken

Example: 372036854775807

id*

Type: string<uuid>

Unique photo ID.

status*

Type: UploadStatusType

Upload status

Enum: initiated, uploaded, mds_failed, validated, validation_failed

external_id

Type: string

external ID

url

Type: string

URL for uploading photos

RecipientInfo

Information about the recipient of the item

Name

Description

recipient_name*

Type: string

Name of the recipient

recipient_type*

Type: string

What's the relationship between the real recipient
and the recipient specified in the claim

document_id

Type: string

Number of the document confirming the delivery

UploadStatusType

Upload status

Type

Description

UploadStatusType

Enum: initiated, uploaded, mds_failed, validated, validation_failed

404 Not Found

Claim or claim information not found

Body

application/json
{
    "code": "not_found",
    "message": "Claim not found"
}

Name

Description

code*

Type: string

Error code

Example: not_found

Enum: not_found

message*

Type: string

Error description

Example: Claim not found