Applies to integrated customers using the RecoveryConnect API
Document Operations
The Document Operations section provides endpoints used to manage documents associated with orders and recovery records. These endpoints allow users to upload, retrieve, update, and transfer documents such as condition reports, invoices, receipts, and other supporting files related to an order.
All requests must include a valid Bearer token in the request header.
Transfer Specific Document of Order
Description: This endpoint transfers a specific document associated with an order to Client order.
The target order must be specified using the client order ID. The transfer_to field represents the client order ID of the destination order.
All requests must include a valid Bearer Token in the request header.
URL: /api/v130/orders/{order_id}/documents/{document_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 | 57066329
|
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/orders/57066351/documents/182214748 |
Request Body:
{ "transfer_to": [ 57066329 ] } |
Response:
{ "orders": [ { "id": 57066329, "attachments": [ { "id": 180461229, "status": "success" } ] } ] } |