{ "opencollection": "1.0.0", "info": { "name": "OTO API V2 Account Return Shipments API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Return Shipments", "type": "folder" }, "items": [ { "info": { "name": "Create Return Shipment", "type": "http" }, "http": { "method": "POST", "url": "https://api.tryoto.com/rest/v2/rest/v2/createReturnShipment", "body": { "type": "json", "data": "{}" } }, "docs": "This API endpoint creates a new return order for delivered forward orders. A new return order ID is generated by appending a suffix (e.g. -R1, -R2) to the original order ID and is returned in the response for return tracking and related operations. Return processing is handled on an item basis, meaning only the specified items are included in the return order and used for all return-related calculations. Example: Original order ID: ORD-1234 Order status: delivered Result: A new return order is c" }, { "info": { "name": "Get Return Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.tryoto.com/rest/v2/rest/v2/getReturnLink", "body": { "type": "json", "data": "{}" } }, "docs": "This API endpoint generates a link that serves as a return request portal for end customers. The portal allows customers to initiate return requests seamlessly. Additionally, the portal's details and settings can be customized in the OTO Dashboard to align with your specific requirements. Request Parameters: Name Required Type Description orderId yes string The order for which a return request is requested." }, { "info": { "name": "Get Return Details", "type": "http" }, "http": { "method": "POST", "url": "https://api.tryoto.com/rest/v2/rest/v2/getReturnDetails", "body": { "type": "json", "data": "{}" } }, "docs": "This API endpoint allows you to retrieve detailed information about the reverse shipment associated with a specific order. Reverse shipments are typically created when an order is returned or exchanged. This endpoint provides comprehensive insights into the reverse shipment process, including: return reason, returned items etc. Request Parameters: Name Required Type Description orderId yes string Id of the order Response Parameters: returnedItems: An array showing information about items to be r" }, { "info": { "name": "Trigger Return SMS", "type": "http" }, "http": { "method": "POST", "url": "https://api.tryoto.com/rest/v2/rest/v2/triggerReturnSms", "body": { "type": "json", "data": "{}" } }, "docs": "This API endpoint will trigger an SMS for a successful return request, If your SMS settings are configured correctly. Please note that, since the SMS service operates asynchronously, the response does not confirm that the SMS has been delivered to the end customer. For a more detailed investigation of any SMS delivery issues, we recommend checking the SMS Logs under the Logs section in the OTO UI. Request Parameters: Name Required Type Description orderId yes string The orderId you want to trigg" } ] } ], "bundled": true }