Applies to integrated customers using the RecoveryConnect API
Transfer Order Documents
Description: This endpoint transfers documents associated with a specific order to another order.
The target order must be specified using the client order ID. The transfer_to value represents the client order ID of the order where the documents will be transferred, not the internal system order ID.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/orders/{order_id}/documents/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 | 57066350
|
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57066351/documents/transfer |
Request Body:
{ "transfer_to": [ 57066350 ] } |
Response:
{ |
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/v150/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/v150/orders/57066351/documents/182214748 |
Request Body:
{ "transfer_to": [ 57066329 ] } |
Response:
{ "orders": [ { "id": 57066329, "attachments": [ { "id": 180461229, "status": "success" } ] } ] } |