Draft returns-specific errors

Some error responses include a code indicating the specific reason for the error. Refer to the table of error codes below.

Error codes

Loop Returns Documentation

Welcome

Create a Return Authorization

Process Returns in Loop

Deep Link to a Customer Order in the Return Portal

On-Store Exchanges

Partner (Third Party App) Deep Link

Generate Return Details Report

Getting Started

Create a webhook subscription

Validate webhooks from Loop

Return

Label

Label Requests

Happy Returns Shipment

Gift card

Restock

Authentication

Rate limit

Pagination

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.

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 Shopify orders 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 support@loopreturns.com.

```json
{
  "errors": {
    "message": "Return is open and therefore cannot be processed.",
    "code": "UNPROCESSABLE_FLAGGED_RETURN"
  }
}
```

### Required API key scope
- Returns


Process Return

Remove line items from a return and process the return.

Currently, only returns with refund outcomes allow for line items to be removed.

### Required API key scope
- Returns


Remove Line Items

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


Cancel Return

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


Flag Return

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.

### Required API key scope
- Returns


Close Return

Get notes on a specific return using the return's ID.

### Required API key scope
- Returns


Get Return Notes

Post a new note to a return.

### Required API key scope
- Returns


Create Return Note

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


Create Return Deep Link

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


Create Return Deep Link with QR Code

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 no datetimes are passed, the response defaults to only contain returns from the previous 24 hours. See Query Params 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 Query Params below for more information.

### Required API key scope
- Returns


Detailed Returns List

Get the details of a specific return based on a return's ID, an order name, or a Shopify order ID depending on the query value of the call.

### Required API key scope
- Returns


Get Return Details

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


Advanced Shipping Notice

Get all webhook subscriptions. This includes webhooks created programmatically and webhooks created in the Loop Admin.

### Required API key scope
- Developer Tools


Get Webhooks

Create a new webhook subscription.

### Required API key scope
- Developer Tools


Create Webhook

Update a webhook subscriptions.

### Required API key scope
- Developer Tools


Update Webhook

Delete a webhook subscription.

### Required API key scope
- Developer Tools


Delete Webhook

Grade the condition of return line items.

### Required API key scope
- Returns


Grade Items

Assess return line item dispositions.

### Required API key scope
- Returns


Assess Dispositions

Create a cart object and populate it with one or more product variants.

> 🚧 Create Cart Object
>
> When setting up Shop Now: On-Store for a headless store, be sure to create a base 64-encoded liquid cart object and send it to Loop.

### Required API key scope
- Carts


Create Cart

Get an existing cart by cart token. You can get a cart token by calling the Create Cart endpoint.

### Required API key scope
- Carts


Get Cart

Modify an existing cart. Note that the array of product variants included in the request will overwrite the cart's existing contents.

### Required API key scope
- Carts


Update Cart

Delete an existing cart in Shop Now On-Store.

### Required API key scope
- Carts


Delete Cart

Retrieve all destinations.

### Required API key scope
- Destinations (Read)


Get All Destinations

Create a destination.

### Required API key scope
- Destinations (Write)


Create Destination

Get details for a single destination.

### Required API key scope
- Destinations (Read)


Get Destination Details

Update a destination.

### Required API key scope
- Destinations (Write)


Update Destination

Delete a destination.

### Required API key scope
- Destinations (Write)


Delete Destination

Retrieve a list of paginated blocklist entries.

### Required API key scope
- Orders


List Blocklist Items

Create a blocklist entry.

### Required API key scope
- Orders


Create Blocklist Item

Retrieve a blocklist entry.

### Required API key scope
- Orders


Get Blocklist Item

Delete a blocklist entry.

### Required API key scope
- Orders


Delete Blocklist Item

Retrieve a list of paginated allowlist entries.

### Required API key scope
- Orders


List Allowlist Items

Create an allowlist entry.

### Required API key scope
- Orders


Create Allowlist Item

Retrieve an allowlist entry.

### Required API key scope
- Orders


Get Allowlist Item

Delete an allowlist entry.

### Required API key scope
- Orders


Delete Allowlist Item

Attach a fraud report to a return.

### Required API key scope
- Returns


Create Fraud Report

Get high level information from a Happy Returns shipment.

### Required API key scope
- Happy Returns Shipments (Read)


Get Shipment Information

Get information about all Happy Returns shipments created within a given timeframe. 
The response is a paginated list of shipments, with up to 200 shipments per page. 

If no date range is provided, the response will return data from the last 24 hours.

### Required API key scope
- Happy Returns Shipments (Read)


Get Shipments

Get all items for a Happy Returns shipment.

### Required API key scope
- Happy Returns Shipments (Read)


Get Shipment Items

Retrieve a list of label requests.

#### Required API key scope
- Labels (Read)


List Label Requests

Get details about a single label request.

#### Required API key scope
- Labels (Read)


Get Label Request

Submit unrecoverable errors encountered when generating labels for merchants.

#### Required API key scope
- Labels (Write)


Create a label request error

Create a label for a label request.

#### Required API key scopes
- Labels (Write)
- Label Requests (Write)
- Developer Tools


Create Label

Update the status of the label.

#### Required API key scope
- Labels (Write)


Error Code	Description
`UNEXPECTED_ERROR`	An unexpected error occurred. Contact Loop Support if the error persists.
`ORDER_NOT_FOUND`	An order with the specified ID could not be found.
`NOT_AUTHORIZED`	The request couldn’t be processed because authorization failed. Confirm that your API key is correct and try again.
`NOT_FOUND`	The resource requested was not found
`UNPROCESSABLE_RETURN`	The return cannot be processed because it is in a state that keeps it from being processed. Check the state of the return and make sure it is eligible for processing.
`UNPROCESSABLE_FLAGGED_RETURN`	Unless enabled, flagged returns cannot be processed. If you would like to configure your flagged returns to process, please adjust the “Allow flagged returns to process” setting in your Loop Admin.
`FAILED_TO_GET_WEBHOOKS`	The webhooks requested could not be returned. Contact Loop Support if the error persists.
`FAILED_TO_DELETE_WEBHOOK`	The webhook could not be deleted. Contact Loop Support if the error persists.
`FAILED_TO_CREATE_WEBHOOK`	The webhook could not be created. Contact Loop Support if the error persists.
`FAILED_TO_UPDATE_WEBHOOK`	The webhook could not be updated. Contact Loop Support if the error persists.
`FAILED_TO_GET_SAMPLE_WEBHOOK`	The sample webhook could not be returned. Contact Loop Support if the error persists.
`DESTINATION_LIMIT_EXCEEDED`	You have exceeded the number of destinations included in your plan. Contact your Merchant Success Manager or Loop Support for more information.

Error Code	Description
`draft-returns-not-enabled`	Draft returns are not enabled for this shop.
`validation-failed`	Validation failed.
`shop-not-found`	Shop not found.
`order-lookup-failed`	Failed to lookup the order.
`order-not-found`	Order not found.
`error-retrieving-order`	Error retrieving order.
`secondary-input-mismatch`	Secondary input mismatch.
`returns-unavailable-from-order-address`	Returns unavailable from order address.
`returns-unavailable-for-order`	Returns unavailable for order.
`order-has-been-cancelled`	Order has been cancelled.
`order-get-data-failed`	Failed to get order data.
`order-line-item-get-data-failed`	Failed to get order line item data.
`draft-return-not-found`	Draft return not found.
`draft-return-version-mismatch`	Draft return version mismatch.
`draft-return-not-actionable`	Draft return is not actionable.
`unable-to-resolve-action-handler`	Unable to resolve action handler.
`action-failed`	Action failed.
`partial-context-generation`	Partial context generation.
`partial-available-action-generation`	Partial available action generation.
`no-returning-items`	No returning items.
`cart-error`	Cart error.
`totals-calculation-failed`	Failed to calculate totals.
`return-creation-failed`	Failed to create return.
`terminal-state`	Draft return has been `{state}` and cannot be modified (where `{state}` is the current state). Terminal states include `submitted`, `cancelled`, and `expired`.
`unsupported-feature`	Unsupported feature.
`internal-error`	An unexpected error occurred.

Using the API

APIs

Error codes

Draft returns-specific errors

Using the API

APIs

​Draft returns-specific errors

Draft returns-specific errors