Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Return Data

Get Return Details

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/warehouse/return/details

Query parameters

return_idinteger

The unique identifier associated with the return.

order_idinteger

The unique identifier associated with the order.

order_namestring

The order name from the commerce provider (e.g. Shopify).

currency_type'shop' | 'presentment'

The currency type of the return.

If set to shop, all currency fields in the response will use the shop's currency.

If set to presentment, all currency fields in the response will use the currency presented to the shopper when they made the purchase.

Response

Success

OR
OR

Example response

{
  "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": 3838173,
  "order_name": "1138",
  "order_number": 138,
  "provider_order_number": 1138,
  "provider_order_id": 5444175757553,
  "total": "192.42",
  "customer": "email@loopreturns.com",
  "state": "cancelled",
  "currency": "USD",
  "exchange": "0.00",
  "exchange_order_name": [
    "EXC-4736272-1",
    "EXC-4736272-2"
  ],
  "exchange_order_id": [
    2342352463453,
    2342352463454
  ],
  "gift_card_order_name": "Gift Card Name",
  "gift_card_order_id": 987651987684,
  "gift_card": "0.00",
  "gift_card_presentment": {
    "value": "0.00",
    "currency": "CAD"
  },
  "refund": "192.42",
  "refunds": [
    {
      "gateway": "Stripe",
      "amount": "78.00",
      "currency": "USD",
      "provider_refund_id": "12345",
      "provider": "reshop"
    }
  ],
  "return_product_total": "156.00",
  "return_discount_total": "0.00",
  "return_tax_total": "8.58",
  "return_total": "164.58",
  "refund_shipping_total": "4.00",
  "refund_shipping_tax_total": "0.40",
  "return_credit_total": "101.28",
  "handling_fee": "0.00",
  "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": "0.00",
  "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",
      "consolidation_tracking": "MS6681181",
      "consolidation_destination_id": "357",
      "reason": "Item was too small",
      "parent_reason": "Item didn't fit",
      "refund_tax": "4.29",
      "refund_item": "27.36",
      "refund_shipping": "4.00",
      "refund_excluding_shipping": "27.65",
      "refund_shipping_tax": "0.40",
      "refund_excluding_shipping_tax": "4.29",
      "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": {
        "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"
      }
    }
  ],
  "presentment": {
    "currency": "CAD",
    "return_product_total": "156.00",
    "return_discount_total": "0.00",
    "return_tax_total": "8.58",
    "return_total": "164.58",
    "return_shipping_total": "4.00",
    "return_shipping_tax_total": "0.40",
    "credit_shipping_total": "0.00",
    "handling_fee": "0.00",
    "return_credit_total": "0.00",
    "gift_card": "0.00",
    "refund": "168.58",
    "refund_breakdown": [
      {
        "gateway": "shopify_payments",
        "provider": "shopify",
        "amount": "168.58",
        "currency": "CAD"
      }
    ],
    "line_items": [
      {
        "line_item_id": "59989689",
        "price": "156.00",
        "discount": "0.00",
        "tax": "8.58"
      }
    ]
  },
  "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",
  "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",
  "labels": [
    {
      "status": "N/A",
      "updated_at": "2023-01-01T22:27:18.000Z",
      "url": "http://example.label.url",
      "carrier": "USPS",
      "tracking_number": "9999999999999999999999",
      "line_items": [
        1001,
        1002
      ]
    }
  ]
}