Loop Returns

Cancel a return in Loop. Canceling a return will allow a customer to make another return with the same items. ### Required API key scope - Returns

Close a return. Closing a return will not fulfill any outcomes such as exchanges or gift cards, and the items are not able to be used in a new return. Returns closed using this endpoint will also be closed in the commerce provider (e.g. Shopify). ### Required API key scope - Returns

Create a deep link URL. Depending on a shop's settings, the `zip` value could be an email, phone number, or postal code. All use the key `zip`. ### Required API key scope - Orders

Generate a link to a QR code image file that, when scanned, will take the user directly to their order in Loop so they can initiate a return without requiring them to enter their order information. The deep link URL is also returned. If `type` is not included in the request, or is a non-supported format, a `png` will be returned. ### Required API key scope - Orders

Post a new note to a return. ### Required API key scope - Returns

Flag a return in Loop for review. This will prevent automated processing and will require a human to go into the merchant admin in Loop and review this return. ### Required API key scope - Returns

This endpoint will pull all packages by tracking statuses/timeframe. The ASN endpoint will return an array of objects. Those objects will contain order and return information. ### Required API key scope - Returns

Pull a detailed list of returns created within a given timeframe. This endpoint supports pagination. We _highly_ encourage using [pagination](https://docs.loopreturns.com/reference/paginated-requests) for this endpoint. Read the guide on [paginating requests](https://docs.loopreturns.com/reference/paginated-requests) for details. **Note**: If neither `from` nor `to` is passed, the response defaults to only contain returns from the previous 24 hours. See [`from`](#parameter-from) and [`to`](#parameter-to) below for more information. **Note**: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned. **Note**: If no `state` is passed, the response defaults to only contain open, closed, and expired returns. See [`state`](#parameter-state) below for more information. ### Required API key scope - Returns

Get the details of a specific return based on a return's ID, an order name, or an order ID from the commerce provider (e.g. Shopify) depending on the query value of the call. ### Required API key scope - Returns

Get notes on a specific return using the return's ID. ### Required API key scope - Returns

Process a return in Loop based on the return ID. Processing a return will archive it in Loop and fulfill any remaining outcomes, such as placing exchange orders or creating gift cards. > ⚡ **Processing Note** > > This endpoint queues the return for processing. The actual processing occurs in the background. > A successful response indicates the return has been queued, not that processing has completed. > **Note on instant refunds** > > If the return has an open Reshop instant-refund credit, processing is intentionally skipped: a > successful (`true`) response is returned without dispatching any processing jobs. Optionally, you may include a JSON payload in the request body. If you choose to do so, Loop will add these values to any new orders in the commerce provider (e.g. Shopify) that result from processing the return. For example, if the return includes an exchange when the return is processed, Loop will create that exchange order and these values will be added to the order as "Additional Details." Loop will also add a note to the return timeline with the values in the request body. > 🚧 Process Error Codes > > Returns must be in a processable state to successfully process. If your return is not in a > processable state, your response will include an `errors` object with a corresponding message and > error code. > > > If you would like to configure your flagged returns to process, please reach out to > [email protected]. ```json { "errors": { "message": "Return is open and therefore cannot be processed.", "code": "UNPROCESSABLE_FLAGGED_RETURN" } } ``` ### Required API key scope - Returns

Remove line items from a return and process the return. Currently, only line items tied to a refund or store credit outcome allow for line items to be removed programmatically. ### Required API key scope - Returns