10.2. Get claim information

Returns claim information as proof of delivery.
You may receive this information as any of the following: point ID, photos
the courier took at that location, and the name(s) of the recipient(s).

HTTP Request

POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/proof-of-delivery/info\
?claim_id={string}

Query Parameters

claim_id *

string

The claim ID received at the claim creation stage

* Required parameter

Header Parameters

X-B2B-Client-Id *	string
Accept-Language *	string Preferred language of response. Examples: "ru" — Russian, "en" — English

* Required parameter

Responses

Code 200

{
  "proof_of_delivery_info": [
    {
      "claim_point_id": integer,
      "photos": [
        {
          "claim_point_id": integer,
          "external_id": string,
          "id": string,
          "status": string,
          "url": string
        }
      ],
      "recipient_info": {
        "document_id": string,
        "recipient_name": string,
        "recipient_type": string
      }
    }
  ]
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

proof_of_delivery_info[] *	array
proof_of_delivery_info[].claim_point_id *	integer The integer ID (int64) of the point generated on the Delivery side. Contained in the field route_points[].id. Applicable to points with type source, destination, return.
proof_of_delivery_info[].photos[]	array
proof_of_delivery_info[].photos[].claim_point_id *	integer point_id of the claim point (int64). Returned to understand which point the photo belongs to.
proof_of_delivery_info[].photos[].external_id	string External ID, taken from the cargo_orders_proof_of_delivery_settings experiment
proof_of_delivery_info[].photos[].id *	string Photo ID in postgres. Returns to maintain links to claim_point_id.
proof_of_delivery_info[].photos[].status *	string Upload status Allowed values initiated uploaded mds_failed validated validation_failed
proof_of_delivery_info[].photos[].url *	string url for the upload
proof_of_delivery_info[].recipient_info	object
proof_of_delivery_info[].recipient_info.document_id	string
proof_of_delivery_info[].recipient_info.recipient_name *	string Recipient's name
proof_of_delivery_info[].recipient_info.recipient_type *	string Who is the actual recipient in relation to the recipient specified in the claim

* Required parameter

Code 404

Claim not found or claim information not found

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

code *	string String error code Allowed values not_found
message *	string Human-readable error message

* Required parameter

Example

Responses:

{
  "proof_of_delivery_info": [
    {
      "claim_point_id": 6987
    }
  ]
}
Copied to clipboard