Detailed Returns List

get https://api.loopreturns.com/api/v1/warehouse/return/list

Pull a detailed list of returns created within a given timeframe.

This endpoint supports pagination. We highly encourage using pagination for this endpoint.

Read the guide on paginating 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.

Responses

Response body

array of objects

object

string

The unique identifier associated with the return.

state

string

The current state of the return.

created_at

date-time

The date and time at which the return was created, using the ISO 8601 date format.

updated_at

date-time

The date and time at which the return was last updated, using the ISO 8601 date format.

edited_at

date-time

The date and time at which the return was last edited, using the ISO 8601 date format.

total

string

The total cost of the return.

outcome

string

The outcome of the return as limited by the merchant and as selected by the customer.

exchange upsell refund credit exchange+refund exchange+credit

order_id

string

The Loop order identifier associated with the return.

order_name

string

The order name.

provider_order_id

string

The Shopify order ID.

order_number

string

The order number.

provider_order_number

string

The Shopify order number.

customer

string

The customer's email address.

origin_country

string | null

The country of the customer's shipping address.

origin_country_code

string | null

The ISO 3166-1 alpha-2 country code of the customer's shipping address.

multi_currency

boolean

Whether the order was placed through Shopify Payments in some currency other than the default store currency.

currency

string

The currency code of the store's default currency.

return_product_total

string

The gross value of the returning items before discounts and tax.

return_discount_total

string

The total value of the discounts on the returning items.

return_tax_total

string

The total value of the taxes on the returning items.

return_total

string

The net value of the returning items after discounts and tax.

return_credit_total

string

The value of the returning items credited to the shopper after the refund has been issued.

exchange_product_total

string

The gross value of the exchange before discounts and tax.

exchange_discount_total

string

The total value of discounts on the exchange.

exchange_tax_total

string

The total value of the taxes on the exchange.

exchange_total

string

The net value of the exchanges after discounts and tax.

exchange_credit_total

string

The value of the return credit used by the shopper.

gift_card

string

The value of the gift card issued in the return.

gift_card_order_name

string

The name of the gift card order issued in the return.

gift_card_order_id

string

The unique identifier of the gift card issued in the return.

handling_fee

string

The handling fee charged by the merchant.

refund

string

The amount refunded in the return.

upsell

string

The upsell amount associated with the return.

line_items

array of objects

line_items

object

line_item_id

string

The unique identifier associated with the line item.

provider_line_item_id

string

The Shopify or other platform identifier associated with the line item.

product_id

string

The unique identifier associated with the product.

variant_id

string

The unique identifier associated with the product variant.

sku

string

The SKU associated with the product.

title

string

The product's name.

price

string

The product's price.

discount

string

The discount amount associated with the line item.

tax

string

The tax amount associated with the line item.

refund

string

The refund amount associated with the line item.

refund_item

string

The refund amount minus the tax amount.

refund_tax

string

Equal to the refund.

returned_at

date-time

The date and time at which the item was returned, using the ISO 8601 date format.

exchange_variant

string

The product variant selected by the customer for exchange (if applicable).

return_reason

string

The specific reason for return given by the customer.

parent_return_reason

string

The general return reason category given by the customer.

return_comment

string

The optional comment left by the customer when returning the product.

barcode

string

The barcode of the product.

outcome

string

The return outcome, as permitted by the merchant's return policy.

reject donate review default keep

provider_restock_location_id

string

The restock location for the return.

consolidation_tracking

string

If a line item is part of a consolidated shipment of many return items, this value holds the tracking value for the consolidated shipment that contains this item such as the Happy Returns Outbound Shipment tracking number.

condition

object

disposition

object

exchanges

array of objects

exchanges

object

exchange_id

string

The unique identifier associated with the exchange.

exchange_order_id

int64

The unique identifier associated with the exchange order.

exchange_order_name

string

The name of the exchange order.

product_id

string

The unique identifier associated with the product.

variant_id

string

The unique identifier associated with the product variant.

sku

string

The SKU associated with the product.

type

string

The order type.

title

string

The product's name.

price

string

The product's price.

discount

string

The discount amount associated with the exchange.

tax

string

The tax amount associated with the line item.

total

string

The sum of the product's price and any tax, minus any discount applied.

out_of_stock

boolean

Whether the product is in or out of stock.

out_of_stock_resolution

string

consolidation_tracking

string

carrier

string

The carrier associated with the return.

tracking_number

string

The return's tracking number.

label_status

string

The status of the return shipping label.

label_url

string

The link to the shipping label details.

label_rate

string

The shipping rate paid for the return label.

status_page_url

string

The link to the Loop return tracking status page associated with the return.

label_updated_at

date-time

The date and time at which the label was last updated, using the ISO 8601 date format.

destination_id

string

The unique identifier associated with the shipping destination of the return.

return_method

object

package_reference

string

The data used to look up package data in WMS software.

type

string

The type of return submission.

standard warranty

labels

array of objects

labels

object

status

string

The status of the return shipping label.

updated_at

date-time

The date and time at which the label was last updated, using the ISO 8601 date format.

url

The link to the shipping label details.

rate

integer

The shipping rate paid for the return label.

carrier

string

The carrier associated with the return.

tracking_number

string

The tracking number associated with the return.

line_items

array of integers

A list of line item ids associated with the label.

line_items

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.loopreturns.com/api/v1/warehouse/return/list?filter=created_at' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Defaults to only contain open, closed, and expired returns.

200Success

401Unauthorized

422Unprocessable