Swap Get Returns
It uses the following Swap Returns API V2 endpoint: https://docs.api-swap-os.com/products/returns/returns-reference/get-external-returns-v-2/
Note: This action requires a Swap Module Connection to be set up.
Inputs
| Name | Type | Description |
|---|---|---|
| Search By | String | The field to search returns by. One of: Order Number, Email, Custom Query. |
| Value | String | The value to search for, corresponding to the selected Search By field. |
| Results | Optional Number | Number of results to return. Defaults to 3. |
| Safe Mode | Optional Boolean | If set to True, errors are logged in the Action Outputs instead of stopping the Flow. Defaults to False. |
Outputs
| Name | Type | Description |
|---|---|---|
| Success | Boolean | Whether the API call was successful and returns data was retrieved |
| Returns Data | List | Full list of return objects returned by the Swap API |
| Latest Return Data | Object | The most recent return object from the results |
| Return Status | String | The status of the most recent return |
| Return Created Date | String | The date the most recent return was created |
| Return Status Updated Date | String | The date the most recent return was last updated |
| Shipping Carrier | String | The shipping carrier used for the most recent return |
| Return Shipments | List | List of shipment objects associated with the most recent return |
| Return Products | List | List of product objects included in the most recent return |