Get Return Details

GET

warehouse

return

details

curl --request GET \
  --url https://api.loopreturns.com/api/v1/warehouse/return/details \
  --header 'X-Authorization: <api-key>'

{
  "id": 37603915,
  "created_at": "2023-08-22 14:08:31",
  "updated_at": "2023-08-22 15:05:15",
  "edited_at": "2023-08-22 15:05:15",
  "order_id": "<any>",
  "order_name": "<any>",
  "order_number": "<any>",
  "provider_order_number": 1138,
  "provider_order_id": 5444175757553,
  "total": "<any>",
  "customer": "<any>",
  "multi_currency": "<any>",
  "state": "<any>",
  "currency": "<any>",
  "exchange": "<any>",
  "exchange_order_name": "<any>",
  "exchange_order_id": "<any>",
  "gift_card_order_name": "<any>",
  "gift_card_order_id": "<any>",
  "gift_card": "<any>",
  "refund": "<any>",
  "refunds": [
    {
      "gateway": "Stripe",
      "amount": "78.00",
      "currency": "USD",
      "provider_refund_id": "12345"
    }
  ],
  "return_product_total": "156.00",
  "return_discount_total": "0.00",
  "return_tax_total": "8.58",
  "return_total": "164.58",
  "return_credit_total": "101.28",
  "handling_fee": "<any>",
  "exchange_product_total": "96.00",
  "exchange_discount_total": "0.00",
  "exchange_tax_total": "5.28",
  "exchange_total": "101.28",
  "exchange_credit_total": "101.28",
  "upsell": "<any>",
  "line_items": [
    {
      "line_item_id": 293482039,
      "provider_line_item_id": 23984238720,
      "product_id": 29871298313,
      "variant_id": 23498287203948,
      "sku": "2039473-Y",
      "line_item_title": "Black Striped Shirt",
      "variant_title": "Small / Navy",
      "title": "Black Striped Shirt",
      "image": "https://cdn.shopify.com/s/files/1/0000/0000/0000/products/Black_Striped_Shirt.jpg",
      "price": "78.00",
      "discount": "0.00",
      "tax": "4.29",
      "refund": "31.65",
      "returned_at": "2023-01-01T22:27:16.000Z",
      "exchange_variant": "<string>",
      "barcode": "",
      "provider_restock_location_id": "<string>",
      "consolidation_tracking": "<string>",
      "reason": "Item was too small",
      "parent_reason": "Item didn't fit",
      "refund_tax": "4.29",
      "refund_item": "27.36",
      "outcome": "default",
      "condition": {
        "description": "Grade A: No refurbishment needed",
        "condition_category": "grade_c",
        "return_processor": "warehouse-operator@example.com",
        "note": "This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item.",
        "inspected_at": "2023-07-19T15:11:32+00:00",
        "images": [
          "https://example.com/image.jpg"
        ]
      },
      "disposition": {
        "disposition_outcome": "back_to_stock",
        "return_processor": "warehouse-operator@example.com",
        "note": "This item will be returned to stock after bagging and tagging",
        "inspected_at": "2023-07-19T15:11:32+00:00"
      }
    }
  ],
  "customer_email": "email@loopreturns.com",
  "carrier": "USPS",
  "label_status": "out_for_delivery",
  "label_updated_at": "2023-08-21T14:09:17.000Z",
  "label_url": "https://test-bucket.s3-us-west-2.amazonaws.com/files/postage_label/01234567/0df7eea6147b44b7ac204e9eb8293cfa.pdf",
  "label_rate": "250",
  "outcome": "exchange",
  "tracking_number": "9999999999999999999999",
  "destination_id": "17",
  "status_page_url": "https://sample-store.loopreturns.com/#/return/beee8df-b948-4feb-8e23-8cfd2d1e3565",
  "return_method": "happy-returns",
  "package_reference": "9999999999999999999999",
  "shopify_refund_object": [
    {
      "id": 1,
      "return_id": 123456789,
      "provider_refund_id": 987654321,
      "provider_created_at": "2023-01-01T20:18:04.000Z",
      "created_at": "2023-01-01T22:27:18.000Z",
      "updated_at": "2023-01-01T22:27:18.000Z"
    }
  ],
  "exchanges": [],
  "customer_first_name": "Alex",
  "customer_last_name": "Doe",
  "type": "standard",
  "labels": [
    {
      "status": "N/A",
      "updated_at": "2023-01-01T22:27:18.000Z",
      "url": "http://example.label.url",
      "rate": 123,
      "carrier": "USPS",
      "tracking_number": "9999999999999999999999",
      "line_items": [
        1001,
        1002
      ]
    }
  ]
}

Authorizations

X-Authorization

string

header

required

Query Parameters

return_id

integer

The unique identifier associated with the return.

order_id

integer

The unique identifier associated with the order.

order_name

string

The Shopify order name.

Response

200

application/json

Success

integer

The unique identifier associated with the return.

created_at

string

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

updated_at

string

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

edited_at

string

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

order_id

any

The Loop order identifier associated with the return.

order_name

any

The order name.

order_number

any

The order number.

provider_order_number

integer

The Shopify order number.

provider_order_id

integer

The Shopify order ID.

total

any

The total cost of the return.

customer

any

The customer's email address.

multi_currency

any

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

state

any

The status of the return.

currency

any

The currency code of the store's default currency.

exchange

any

The value of the exchange.

exchange_order_name

any

The name of the exchange order.

exchange_order_id

any

The unique identifier associated with the exchange order.

gift_card_order_name

any

The name of the gift card order.

gift_card_order_id

any

The unique identifier associated with the gift card order.

gift_card

any

The gift card amount.

refund

any

The refund amount in the presentment currency.

refunds

object[]

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.

handling_fee

any

The handling fee charged by the merchant.

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.

upsell

any

The upsell amount associated with the return.

line_items

object[]

customer_email

string

The customer's email address.

carrier

string

The carrier associated with the return.

label_status

string

The delivery status of the return.

label_updated_at

string

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

label_url

string

The link to the shipping label.

label_rate

string

The shipping rate paid for the return label.

outcome

enum<string>

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

Available options:

exchange,

upsell,

refund,

credit,

exchange+refund,

exchange+credit

tracking_number

string

The tracking number associated with the return.

destination_id

string

The unique identifier associated with the return's destination.

status_page_url

string

The link to the return's status page.

return_method

string

The return method.

package_reference

string

The package reference of the return.

shopify_refund_object

object[]

exchanges

any[]

customer_first_name

string

customer_last_name

string

type

enum<string>

The type of return submission.

Available options:

standard,

warranty

labels

object[]

Detailed Returns List Advanced Shipping Notice

curl --request GET \
  --url https://api.loopreturns.com/api/v1/warehouse/return/details \
  --header 'X-Authorization: <api-key>'

{
  "id": 37603915,
  "created_at": "2023-08-22 14:08:31",
  "updated_at": "2023-08-22 15:05:15",
  "edited_at": "2023-08-22 15:05:15",
  "order_id": "<any>",
  "order_name": "<any>",
  "order_number": "<any>",
  "provider_order_number": 1138,
  "provider_order_id": 5444175757553,
  "total": "<any>",
  "customer": "<any>",
  "multi_currency": "<any>",
  "state": "<any>",
  "currency": "<any>",
  "exchange": "<any>",
  "exchange_order_name": "<any>",
  "exchange_order_id": "<any>",
  "gift_card_order_name": "<any>",
  "gift_card_order_id": "<any>",
  "gift_card": "<any>",
  "refund": "<any>",
  "refunds": [
    {
      "gateway": "Stripe",
      "amount": "78.00",
      "currency": "USD",
      "provider_refund_id": "12345"
    }
  ],
  "return_product_total": "156.00",
  "return_discount_total": "0.00",
  "return_tax_total": "8.58",
  "return_total": "164.58",
  "return_credit_total": "101.28",
  "handling_fee": "<any>",
  "exchange_product_total": "96.00",
  "exchange_discount_total": "0.00",
  "exchange_tax_total": "5.28",
  "exchange_total": "101.28",
  "exchange_credit_total": "101.28",
  "upsell": "<any>",
  "line_items": [
    {
      "line_item_id": 293482039,
      "provider_line_item_id": 23984238720,
      "product_id": 29871298313,
      "variant_id": 23498287203948,
      "sku": "2039473-Y",
      "line_item_title": "Black Striped Shirt",
      "variant_title": "Small / Navy",
      "title": "Black Striped Shirt",
      "image": "https://cdn.shopify.com/s/files/1/0000/0000/0000/products/Black_Striped_Shirt.jpg",
      "price": "78.00",
      "discount": "0.00",
      "tax": "4.29",
      "refund": "31.65",
      "returned_at": "2023-01-01T22:27:16.000Z",
      "exchange_variant": "<string>",
      "barcode": "",
      "provider_restock_location_id": "<string>",
      "consolidation_tracking": "<string>",
      "reason": "Item was too small",
      "parent_reason": "Item didn't fit",
      "refund_tax": "4.29",
      "refund_item": "27.36",
      "outcome": "default",
      "condition": {
        "description": "Grade A: No refurbishment needed",
        "condition_category": "grade_c",
        "return_processor": "warehouse-operator@example.com",
        "note": "This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item.",
        "inspected_at": "2023-07-19T15:11:32+00:00",
        "images": [
          "https://example.com/image.jpg"
        ]
      },
      "disposition": {
        "disposition_outcome": "back_to_stock",
        "return_processor": "warehouse-operator@example.com",
        "note": "This item will be returned to stock after bagging and tagging",
        "inspected_at": "2023-07-19T15:11:32+00:00"
      }
    }
  ],
  "customer_email": "email@loopreturns.com",
  "carrier": "USPS",
  "label_status": "out_for_delivery",
  "label_updated_at": "2023-08-21T14:09:17.000Z",
  "label_url": "https://test-bucket.s3-us-west-2.amazonaws.com/files/postage_label/01234567/0df7eea6147b44b7ac204e9eb8293cfa.pdf",
  "label_rate": "250",
  "outcome": "exchange",
  "tracking_number": "9999999999999999999999",
  "destination_id": "17",
  "status_page_url": "https://sample-store.loopreturns.com/#/return/beee8df-b948-4feb-8e23-8cfd2d1e3565",
  "return_method": "happy-returns",
  "package_reference": "9999999999999999999999",
  "shopify_refund_object": [
    {
      "id": 1,
      "return_id": 123456789,
      "provider_refund_id": 987654321,
      "provider_created_at": "2023-01-01T20:18:04.000Z",
      "created_at": "2023-01-01T22:27:18.000Z",
      "updated_at": "2023-01-01T22:27:18.000Z"
    }
  ],
  "exchanges": [],
  "customer_first_name": "Alex",
  "customer_last_name": "Doe",
  "type": "standard",
  "labels": [
    {
      "status": "N/A",
      "updated_at": "2023-01-01T22:27:18.000Z",
      "url": "http://example.label.url",
      "rate": 123,
      "carrier": "USPS",
      "tracking_number": "9999999999999999999999",
      "line_items": [
        1001,
        1002
      ]
    }
  ]
}

Using the API

APIs

Required API key scope

Authorizations

Query Parameters

Response