10.1. Get photos by point
Makes a request to receive temporary link(s)
for the photograph(s) related to the claim and the courier's point if
- The claim is valid.
- The point is relevant to the claim.
HTTP Request
POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/photos_by_point
Header Parameters
Accept-Language * | string Preferred language of response. Examples: "ru" — Russian, "en" — English |
X-B2B-Client-Id * | string |
* Required parameter
Request Body
{ "claim_id": string, "claim_point_id": integer }
Copied to clipboard
Representation
Fields
claim_id * | string The claim ID received at the claim creation stage |
claim_point_id * | integer The integer ID (int64) of the point generated on the Delivery side. |
* Required parameter
Responses
Code 200
Ok
{ "photos": [ { "claim_point_id": integer, "external_id": string, "id": string, "status": string, "url": string } ] }
Copied to clipboard
Representation
Fields
photos[] * | array |
photos[]. | integer point_id of the claim point (int64). Returned to understand which point the photo belongs to. |
photos[]. | string External ID, taken from the cargo_orders_proof_of_delivery_settings experiment |
photos[]. | string Photo ID in postgres. Returns to maintain links to claim_point_id. |
photos[]. | string Upload status Allowed values
|
photos[]. | string url for the upload |
photos[] * | array |
photos[]. | integer point_id of the claim point (int64). Returned to understand which point the photo belongs to. |
photos[]. | string External ID, taken from the cargo_orders_proof_of_delivery_settings experiment |
photos[]. | string Photo ID in postgres. Returns to maintain links to claim_point_id. |
photos[]. | string Upload status Allowed values
|
photos[]. | string url for the upload |
* Required parameter
Code 400
Point outside claim
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 404
Claim not found or photos not found
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Example
Request:
curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/photos_by_point" \ -H "Accept-Language: {string}" \ -H "X-B2B-Client-Id: {string}" \ -d '{ "claim_id": "741cedf82cd464fa6fa16d87155c636", "claim_point_id": 6987 }'
Copied to clipboard