Applies to integrated customers using the RecoveryConnect API
Photo Operations
The Photo Operations section provides endpoints used to manage photos associated with orders. These endpoints allow users to upload, retrieve, update, and transfer photos related to an order, such as vehicle images, damage photos, and other supporting visual documentation.
All requests must include a valid Bearer token in the request header.
Transfer Specific Photo of Order
Description: This endpoint transfers a specific photo associated with an order to another order.
The destination order must be provided in the request body using the client order ID. The transfer_to field represents the client order ID of this order where the photo will be transferred.
All requests must include a valid Bearer Token in the request header.
URL: /api/v130/orders/{order_id}/photos/{photo_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | |
transfer_to | Array containing the client order ID(s) of the order(s) to which the documents will be transferred | Yes | 57076502 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/orders/57076503/photos/180461379 |
Request Body:
{ "transfer_to": [ 57076502 ] } |
Response:
{ "orders": [ { "id": 57076502, "attachments": [ { "id": 180461379, "status": "success" } ] } ] } |
Transfer Order Photos
Description: This endpoint transfers all photos associated with a specific order to another order.
The destination order must be specified in the request body using the client order ID. The transfer_to field represents the client order ID of the destination order where the photos will be transferred.
All requests must include a valid Bearer Token in the request header.
URL: /api/v130/orders/{order_id}/photos/transfer
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | |
transfer_to | Array containing the client order ID(s) of the order(s) to which the documents will be transferred | Yes | 57076502 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/orders/57076503/photos/transfer |
Request Body:
{ "transfer_to": [ 57076502 ] } |
Response:
{ "orders": [ { "id": 57076502, "attachments": [ { "id": 180461378, "status": "success" } ] }, { "id": 57076502, "attachments": [ { "id": 180461379, "status": "fail" } ] }, { "id": 57076502, "attachments": [ { "id": 180461381, "status": "success" } ] }, { "id": 57076502, "attachments": [ { "id": 180461382, "status": "success" } ] } ] } |