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: Max length: Example: `` |
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Preferred response language. Examples: "en" — English Example: |
Responses
200 OK
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 |
ClaimPointId
Integer point ID (int64) generated on the Yandex Delivery side.
It is in the route_points[].id field. Applicable to source, destination, and return points.
Type: integer
UploadStatusType
Upload status
Type: string
Enum: initiated, uploaded, mds_failed, validated, validation_failed
Photo
Photos confirming the delivery
|
Name |
Description |
|
claim_point_id |
Type: ClaimPointId Indication of where the photo was taken Integer point ID (int64) generated on the Yandex Delivery side. Example: |
|
id |
Type: string<uuid> Unique photo ID. Example: |
|
status |
Type: UploadStatusType Upload status Enum: |
|
external_id |
Type: string external ID Example: |
|
url |
Type: string URL for uploading photos Example: |
Example
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"claim_point_id": 372036854775807,
"url": "example",
"status": "initiated",
"external_id": "example"
}
RecipientInfo
Information about the recipient of the item
|
Name |
Description |
|
recipient_name |
Type: string Name of the recipient Example: |
|
recipient_type |
Type: string What's the relationship between the real recipient and the recipient specified in the claim Example: |
|
document_id |
Type: string Number of the document confirming the delivery Example: |
Example
{
"recipient_name": "example",
"recipient_type": "example",
"document_id": "example"
}
ProofOfDeliveryInfo
|
Name |
Description |
|
claim_point_id |
Type: ClaimPointId Integer point ID (int64) generated on the Yandex Delivery side. Example: |
|
photos |
Type: Photo[] Example |
|
recipient_info |
Type: RecipientInfo Information about the recipient of the item 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
Claim or claim information not found
Body
application/json
{
"code": "not_found",
"message": "Claim not found"
}
|
Name |
Description |
|
code |
Type: string Error code Const: Example: |
|
message |
Type: string Error description Example: |
No longer supported, please use an alternative and newer version.