# Loop Returns Documentation

## Docs

- [Authentication](https://docs.loopreturns.com/api-reference/authentication.md)
- [Error codes](https://docs.loopreturns.com/api-reference/error-codes.md): Some error responses include a code indicating the specific reason for the error. Refer to the table of error codes below.
- [Getting Started](https://docs.loopreturns.com/api-reference/getting-started.md)
- [Create Allowlist Item](https://docs.loopreturns.com/api-reference/latest/allowlist/create-allowlist-item.md): Create an allowlist entry.
- [Delete Allowlist Item](https://docs.loopreturns.com/api-reference/latest/allowlist/delete-allowlist-item.md): Delete an allowlist entry.
- [Get Allowlist Item](https://docs.loopreturns.com/api-reference/latest/allowlist/get-allowlist-item.md): Retrieve an allowlist entry.
- [List Allowlist Items](https://docs.loopreturns.com/api-reference/latest/allowlist/list-allowlist-items.md): Retrieve a list of paginated allowlist entries.
- [Create Blocklist Item](https://docs.loopreturns.com/api-reference/latest/blocklist/create-blocklist-item.md): Create a blocklist entry.
- [Delete Blocklist Item](https://docs.loopreturns.com/api-reference/latest/blocklist/delete-blocklist-item.md): Delete a blocklist entry.
- [Get Blocklist Item](https://docs.loopreturns.com/api-reference/latest/blocklist/get-blocklist-item.md): Retrieve a blocklist entry.
- [List Blocklist Items](https://docs.loopreturns.com/api-reference/latest/blocklist/list-blocklist-items.md): Retrieve a list of paginated blocklist entries.
- [Create Cart](https://docs.loopreturns.com/api-reference/latest/cart/create-cart.md): 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.
- [Delete Cart](https://docs.loopreturns.com/api-reference/latest/cart/delete-cart.md): Delete an existing cart in Shop Now On-Store.
- [Get Cart](https://docs.loopreturns.com/api-reference/latest/cart/get-cart.md): Get an existing cart by cart token. You can get a cart token by calling the Create Cart endpoint.
- [Update Cart](https://docs.loopreturns.com/api-reference/latest/cart/update-cart.md): Modify an existing cart. Note that the array of product variants included in the request will overwrite the cart's existing contents.
- [Create Destination](https://docs.loopreturns.com/api-reference/latest/destinations/create-destination.md): Create a destination.
- [Delete Destination](https://docs.loopreturns.com/api-reference/latest/destinations/delete-destination.md): Delete a destination.
- [Get All Destinations](https://docs.loopreturns.com/api-reference/latest/destinations/get-all-destinations.md): Retrieve all destinations.
- [Get Destination Details](https://docs.loopreturns.com/api-reference/latest/destinations/get-destination-details.md): Get details for a single destination.
- [Update Destination](https://docs.loopreturns.com/api-reference/latest/destinations/update-destination.md): Update a destination. ### Required API key scope - Destinations (Write)
- [Add Cart Item](https://docs.loopreturns.com/api-reference/latest/draft-returns/add-cart-item.md): Adds an item to the draft return's cart.
- [Add Returning Item](https://docs.loopreturns.com/api-reference/latest/draft-returns/add-returning-item.md): Adds a specific item to the draft return's ReturningItems.
- [Add Returning Item Exchange Item](https://docs.loopreturns.com/api-reference/latest/draft-returns/add-returning-item-exchange-item.md): Adds an exchange item for a specific returning item to the cart. This endpoint is used when a customer is exchanging one item for another.
- [Add Returning Item User Input](https://docs.loopreturns.com/api-reference/latest/draft-returns/add-returning-item-user-input.md): Adds user input for a specific returning item. This allows collecting additional information from the customer about their return.
- [Cancel Draft Return](https://docs.loopreturns.com/api-reference/latest/draft-returns/cancel-draft-return.md): Cancel a draft return.
- [Finalize Items](https://docs.loopreturns.com/api-reference/latest/draft-returns/finalize-items.md): Finalizes the returning items and cart items of the draft return.
- [Get Draft Return](https://docs.loopreturns.com/api-reference/latest/draft-returns/get-draft-return.md): Retrieves the details of a draft return, including its current state, returning items, cart items, and available actions. The response includes the draft return data, context information, and any available actions based on the current state.
- [Initialize Draft Return](https://docs.loopreturns.com/api-reference/latest/draft-returns/initialize-draft-return.md): Initialize a new draft return.
- [Remove Cart Item](https://docs.loopreturns.com/api-reference/latest/draft-returns/remove-cart-item.md): Removes a specific item from the draft return's cart.
- [Remove Returning Item](https://docs.loopreturns.com/api-reference/latest/draft-returns/remove-returning-item.md): Removes a specific item from the draft return's ReturningItems.
- [Select Return Method](https://docs.loopreturns.com/api-reference/latest/draft-returns/select-return-method.md): Selects a return method for the draft return.
- [Set Address](https://docs.loopreturns.com/api-reference/latest/draft-returns/set-address.md): Sets the return shipping address for the draft return.
- [Set Credit Type](https://docs.loopreturns.com/api-reference/latest/draft-returns/set-credit-type.md): Sets the credit type for the draft return.
- [Set Customer](https://docs.loopreturns.com/api-reference/latest/draft-returns/set-customer.md): Sets the customer information for the draft return.
- [Set Returning Item Return Reason](https://docs.loopreturns.com/api-reference/latest/draft-returns/set-returning-item-return-reason.md): Sets the return reason for a specific returning item.
- [Set Returning Item Return Type](https://docs.loopreturns.com/api-reference/latest/draft-returns/set-returning-item-return-type.md): Sets the return type (credit or exchange) for a specific returning item.
- [Submit Draft Return](https://docs.loopreturns.com/api-reference/latest/draft-returns/submit-draft-return.md): Submits the draft return. This finalizes the return and initiates any necessary workflows. Once the return has been submitted, it can be processed.
- [Unfinalize Items](https://docs.loopreturns.com/api-reference/latest/draft-returns/unfinalize-items.md): Reopens the returning items and cart items of the draft return for modification.
- [Get Shipment Items](https://docs.loopreturns.com/api-reference/latest/happy-returns-shipment-items/get-shipment-items.md): Get all items for a Happy Returns shipment.
- [Get Shipment Information](https://docs.loopreturns.com/api-reference/latest/happy-returns-shipment/get-shipment-information.md): Get high level information from a Happy Returns shipment.
- [Get Shipments](https://docs.loopreturns.com/api-reference/latest/happy-returns-shipment/get-shipments.md): 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.
- [Assess Dispositions](https://docs.loopreturns.com/api-reference/latest/item-grading-and-disposition/assess-dispositions.md): Assess return line item dispositions.
- [Grade Items](https://docs.loopreturns.com/api-reference/latest/item-grading-and-disposition/grade-items.md): Grade the condition of return line items.
- [Create Label Request Error](https://docs.loopreturns.com/api-reference/latest/label-requests/create-a-label-request-error.md): Submit unrecoverable errors encountered when generating labels for merchants.
- [Create Label](https://docs.loopreturns.com/api-reference/latest/label-requests/create-label.md): Create a label for a label request.
- [Generate Label](https://docs.loopreturns.com/api-reference/latest/label-requests/generate-label.md): Queue label generation for a return. This endpoint triggers an asynchronous label generation process for the specified return.
- [Get Label Request](https://docs.loopreturns.com/api-reference/latest/label-requests/get-label-request.md): Get details about a single label request.
- [List Label Requests](https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests.md): Retrieve a list of label requests.
- [Update Label Status](https://docs.loopreturns.com/api-reference/latest/label-requests/update-label-status.md): Update the status of the label.
- [Create Webhook](https://docs.loopreturns.com/api-reference/latest/programmatic-webhooks/create-webhook.md): Create a new webhook subscription.
- [Delete Webhook](https://docs.loopreturns.com/api-reference/latest/programmatic-webhooks/delete-webhook.md): Delete a webhook subscription.
- [Get Webhooks](https://docs.loopreturns.com/api-reference/latest/programmatic-webhooks/get-webhooks.md): Get all webhook subscriptions. This includes webhooks created programmatically and webhooks created in the Loop Admin.
- [Update Webhook](https://docs.loopreturns.com/api-reference/latest/programmatic-webhooks/update-webhook.md): Update a webhook subscriptions.
- [Cancel Return](https://docs.loopreturns.com/api-reference/latest/return-actions/cancel-return.md): Cancel a return in Loop. Canceling a return will allow a customer to make another return with the same items.
- [Close Return](https://docs.loopreturns.com/api-reference/latest/return-actions/close-return.md): 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.
- [Create Fraud Report](https://docs.loopreturns.com/api-reference/latest/return-actions/create-fraud-report.md): Attach a fraud report to a return.
- [Create Return Deep Link](https://docs.loopreturns.com/api-reference/latest/return-actions/create-return-deep-link.md): 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`.
- [Create Return Deep Link with QR Code](https://docs.loopreturns.com/api-reference/latest/return-actions/create-return-deep-link-with-qr-code.md): 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.
- [Create Return Note](https://docs.loopreturns.com/api-reference/latest/return-actions/create-return-note.md): Post a new note to a return.
- [Flag Return](https://docs.loopreturns.com/api-reference/latest/return-actions/flag-return.md): 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.
- [Get Return Notes](https://docs.loopreturns.com/api-reference/latest/return-actions/get-return-notes.md): Get notes on a specific return using the return's ID.
- [Process Return](https://docs.loopreturns.com/api-reference/latest/return-actions/process-return.md): 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.
- [Remove Line Items](https://docs.loopreturns.com/api-reference/latest/return-actions/remove-line-items.md): Remove line items from a return and process the return.
- [Advanced Shipping Notice](https://docs.loopreturns.com/api-reference/latest/return-data/advanced-shipping-notice.md): 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.
- [Detailed Returns List](https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list.md): Pull a detailed list of returns created within a given timeframe.
- [Get Return Details](https://docs.loopreturns.com/api-reference/latest/return-data/get-return-details.md): 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.
- [Pagination](https://docs.loopreturns.com/api-reference/pagination.md)
- [Rate limit](https://docs.loopreturns.com/api-reference/rate-limit.md)
- [Commerce Data](https://docs.loopreturns.com/integration-guides/commerce-data.md)
- [Create a Return Authorization](https://docs.loopreturns.com/integration-guides/create-return-authorization.md)
- [Deep Link to a Customer Order in the Return Portal](https://docs.loopreturns.com/integration-guides/deep-link.md)
- [General Integration](https://docs.loopreturns.com/integration-guides/general-integration.md)
- [Generate Return Details Report](https://docs.loopreturns.com/integration-guides/generate-return-details-report.md)
- [Grading & Disposition](https://docs.loopreturns.com/integration-guides/grading-and-disposition.md)
- [Happy Returns](https://docs.loopreturns.com/integration-guides/happy-returns.md)
- [Third Party Labels](https://docs.loopreturns.com/integration-guides/labels-integration.md)
- [Loop Anywhere](https://docs.loopreturns.com/integration-guides/loop-anywhere.md)
- [On-Store Exchanges](https://docs.loopreturns.com/integration-guides/on-store-exchanges.md)
- [Overview](https://docs.loopreturns.com/integration-guides/overview.md)
- [Partner (Third Party App) Deep Link](https://docs.loopreturns.com/integration-guides/partner-deep-link.md)
- [Process Returns in Loop](https://docs.loopreturns.com/integration-guides/process-returns.md)
- [Actioning on Returns](https://docs.loopreturns.com/integration-guides/return-actions.md)
- [Retrieving Return Data](https://docs.loopreturns.com/integration-guides/return-data.md)
- [Contact](https://docs.loopreturns.com/resources/contact.md)
- [FAQ](https://docs.loopreturns.com/resources/faq.md)
- [Checking Item Return Eligibility with the Return Create API](https://docs.loopreturns.com/return-create-api/eligibility-api.md)
- [Getting Started with the Return Create API](https://docs.loopreturns.com/return-create-api/return-create-api.md)
- [Getting Started](https://docs.loopreturns.com/webhook-reference/getting-started.md)
- [Create a webhook subscription](https://docs.loopreturns.com/webhook-reference/setting-up.md)
- [Gift card](https://docs.loopreturns.com/webhook-reference/topics/gift-card-webhook.md)
- [Happy Returns Shipment](https://docs.loopreturns.com/webhook-reference/topics/happy-returns-shipment-webhook.md)
- [Label requests](https://docs.loopreturns.com/webhook-reference/topics/label-requests-webhook.md)
- [Label](https://docs.loopreturns.com/webhook-reference/topics/label-webhook.md)
- [Restock](https://docs.loopreturns.com/webhook-reference/topics/restock-webhook.md)
- [Return](https://docs.loopreturns.com/webhook-reference/topics/return-webhook.md)
- [Validate webhooks from Loop](https://docs.loopreturns.com/webhook-reference/validation.md)
- [Welcome](https://docs.loopreturns.com/welcome.md): Welcome to Loop Returns!

## OpenAPI Specs

- [checkout-plus-api](https://docs.loopreturns.com/openapi/checkout-plus-api.yaml)
- [return-webhook](https://docs.loopreturns.com/openapi/return-webhook.yaml)
- [destinations-api](https://docs.loopreturns.com/openapi/destinations-api.yaml)
- [hq-api](https://docs.loopreturns.com/openapi/hq-api.yaml)
- [returns-api](https://docs.loopreturns.com/openapi/returns-api.yaml)
- [labels-api](https://docs.loopreturns.com/openapi/labels-api.yaml)
- [products-api](https://docs.loopreturns.com/openapi/products-api.yaml)
- [draft-returns](https://docs.loopreturns.com/openapi/draft-returns.yaml)
- [inventories-api](https://docs.loopreturns.com/openapi/inventories-api.yaml)
- [label-requests-webhook](https://docs.loopreturns.com/openapi/label-requests-webhook.yaml)
- [carts-api](https://docs.loopreturns.com/openapi/carts-api.yaml)
- [orders-api](https://docs.loopreturns.com/openapi/orders-api.yaml)
- [service-reference-api](https://docs.loopreturns.com/openapi/service-reference-api.yaml)
- [restock-webhook](https://docs.loopreturns.com/openapi/restock-webhook.yaml)
- [locations-api](https://docs.loopreturns.com/openapi/locations-api.yaml)
- [listings-api](https://docs.loopreturns.com/openapi/listings-api.yaml)
- [label-webhook](https://docs.loopreturns.com/openapi/label-webhook.yaml)
- [happy-returns-shipment-webhook](https://docs.loopreturns.com/openapi/happy-returns-shipment-webhook.yaml)
- [happy-returns-shipment-items-api](https://docs.loopreturns.com/openapi/happy-returns-shipment-items-api.yaml)
- [gift-card-webhook](https://docs.loopreturns.com/openapi/gift-card-webhook.yaml)
- [fraud-reports-api](https://docs.loopreturns.com/openapi/fraud-reports-api.yaml)
- [flagged-trackers-api](https://docs.loopreturns.com/openapi/flagged-trackers-api.yaml)
- [dispositioning-api](https://docs.loopreturns.com/openapi/dispositioning-api.yaml)
- [customers-api](https://docs.loopreturns.com/openapi/customers-api.yaml)
- [collections-api](https://docs.loopreturns.com/openapi/collections-api.yaml)
- [bulk-operations-api](https://docs.loopreturns.com/openapi/bulk-operations-api.yaml)
- [outgoing-webhooks-api](https://docs.loopreturns.com/openapi/outgoing-webhooks-api.yaml)
- [openapi](https://docs.loopreturns.com/api-reference/openapi.json)

## Optional

- [System Status](https://status.loopreturns.com)