10.1. Get photos by point

  1. HTTP Request
  2. Header Parameters
  3. Request Body
    1. Representation
    2. Fields
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 400
      1. Representation
      2. Fields
    3. Code 404
      1. Representation
      2. Fields
  5. Example

Makes a request to receive temporary link(s)
for the photograph(s) related to the claim and the courier's point if

  1. The claim is valid.
  2. 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

Accept-Language *

string

Preferred language of response. Examples: "ru" — Russian, "en" — English

X-B2B-Client-Id *

string

Request Body

{
  "claim_id": string,
  "claim_point_id": integer
}
Copied to clipboard

Representation

Collapse all
Expand all

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.
Contained in the field route_points[].id. Applicable to points with type
source, destination, return.

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.
Contained in the field route_points[].id. Applicable to points with type
source, destination, return.

Responses

Code 200

Ok

{
  "photos": [
    {
      "claim_point_id": integer,
      "external_id": string,
      "id": string,
      "status": string,
      "url": string
    }
  ]
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

photos[] *

array

photos[].claim_point_id *

integer

point_id of the claim point (int64). Returned to understand which point the photo belongs to.

photos[].external_id

string

External ID, taken from the cargo_orders_proof_of_delivery_settings experiment

photos[].id *

string

Photo ID in postgres. Returns to maintain links to claim_point_id.

photos[].status *

string

Upload status

Allowed values
  1. initiated
  2. uploaded
  3. mds_failed
  4. validated
  5. validation_failed

photos[].url *

string

url for the upload

photos[] *

array

photos[].claim_point_id *

integer

point_id of the claim point (int64). Returned to understand which point the photo belongs to.

photos[].external_id

string

External ID, taken from the cargo_orders_proof_of_delivery_settings experiment

photos[].id *

string

Photo ID in postgres. Returns to maintain links to claim_point_id.

photos[].status *

string

Upload status

Allowed values
  1. initiated
  2. uploaded
  3. mds_failed
  4. validated
  5. validation_failed

photos[].url *

string

url for the upload

Code 400

Point outside claim

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

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. inappropriate_point

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. inappropriate_point

message *

string

Human-readable error message

Code 404

Claim not found or photos not found

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

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. claim_point_not_ready
  2. not_found
  3. photos_not_found

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. claim_point_not_ready
  2. not_found
  3. photos_not_found

message *

string

Human-readable error message

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