---
agentTools:
  projectIndex: https://loop-returns.readme.io/llms.txt
---

# Get Return Details

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.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Returns API",
    "version": "v1",
    "description": "API used for performing operations on returns."
  },
  "servers": [
    {
      "url": "https://api.loopreturns.com/api/v1"
    }
  ],
  "tags": [
    {
      "name": "Return Data"
    }
  ],
  "paths": {
    "/warehouse/return/details": {
      "get": {
        "summary": "Get Return Details",
        "operationId": "getReturnDetails",
        "tags": [
          "Return Data"
        ],
        "security": [
          {
            "api_key": []
          }
        ],
        "description": "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.",
        "parameters": [
          {
            "name": "return_id",
            "description": "The unique identifier associated with the return.",
            "example": 37603922,
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "order_id",
            "description": "The unique identifier associated with the order.",
            "example": 2347613440760,
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "order_name",
            "description": "The Shopify order name.",
            "example": "2222",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ReturnDetails"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        }
      }
    }
  },
  "components": {
    "responses": {
      "ReturnDetails": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/ReturnDetails"
                },
                {
                  "$ref": "#/components/schemas/NoMatchingReturnDetails"
                },
                {
                  "$ref": "#/components/schemas/ReturnDetailsMissingParameters"
                }
              ]
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "examples": [
                        "401"
                      ]
                    },
                    "http_code": {
                      "type": "string",
                      "examples": [
                        "GEN-UNAUTHORIZED"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "examples": [
                        "Unauthorized."
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "ReturnDetails": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "examples": [
              37603915
            ],
            "description": "The unique identifier associated with the return."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-08-22 14:08:31"
            ],
            "description": "The date and time at which the return was created, using the ISO 8601 date format."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-08-22 15:05:15"
            ],
            "description": "The date and time at which the return was last updated, using the ISO 8601 date format."
          },
          "edited_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-08-22 15:05:15"
            ],
            "description": "The date and time at which the return was last edited, using the ISO 8601 date format."
          },
          "order_id": {
            "examples": [
              3838173
            ],
            "description": "The Loop order identifier associated with the return."
          },
          "order_name": {
            "examples": [
              "1138"
            ],
            "description": "The order name."
          },
          "order_number": {
            "examples": [
              138
            ],
            "description": "The order number."
          },
          "provider_order_number": {
            "type": "integer",
            "examples": [
              1138
            ],
            "description": "The Shopify order number."
          },
          "provider_order_id": {
            "type": "integer",
            "examples": [
              5444175757553
            ],
            "description": "The Shopify order ID."
          },
          "total": {
            "examples": [
              "192.42"
            ],
            "description": "The total cost of the return."
          },
          "customer": {
            "examples": [
              "email@loopreturns.com"
            ],
            "description": "The customer's email address."
          },
          "multi_currency": {
            "examples": [
              false
            ],
            "description": "Whether the order was placed through Shopify Payments in some currency other than the default store currency."
          },
          "state": {
            "examples": [
              "cancelled"
            ],
            "description": "The status of the return."
          },
          "currency": {
            "examples": [
              "USD"
            ],
            "description": "The currency code of the store's default currency."
          },
          "exchange": {
            "examples": [
              "0.00"
            ],
            "description": "The value of the exchange."
          },
          "exchange_order_name": {
            "examples": [
              []
            ],
            "description": "The name of the exchange order."
          },
          "exchange_order_id": {
            "examples": [
              []
            ],
            "description": "The unique identifier associated with the exchange order."
          },
          "gift_card_order_name": {
            "examples": [
              "Gift Card Name"
            ],
            "description": "The name of the gift card order."
          },
          "gift_card_order_id": {
            "examples": [
              987651987684
            ],
            "description": "The unique identifier associated with the gift card order."
          },
          "gift_card": {
            "examples": [
              "0.00"
            ],
            "description": "The gift card amount."
          },
          "refund": {
            "examples": [
              "192.42"
            ],
            "description": "The refund amount in the presentment currency."
          },
          "refunds": {
            "$ref": "#/components/schemas/Refunds"
          },
          "return_product_total": {
            "type": "string",
            "examples": [
              "156.00"
            ],
            "description": "The gross value of the returning items before discounts and tax."
          },
          "return_discount_total": {
            "type": "string",
            "examples": [
              "0.00"
            ],
            "description": "The total value of the discounts on the returning items."
          },
          "return_tax_total": {
            "type": "string",
            "examples": [
              "8.58"
            ],
            "description": "The total value of the taxes on the returning items."
          },
          "return_total": {
            "type": "string",
            "examples": [
              "164.58"
            ],
            "description": "The net value of the returning items after discounts and tax."
          },
          "return_credit_total": {
            "type": "string",
            "examples": [
              "101.28"
            ],
            "description": "The value of the returning items credited to the shopper after the refund has been issued."
          },
          "handling_fee": {
            "examples": [
              "0.00"
            ],
            "description": "The handling fee charged by the merchant."
          },
          "exchange_product_total": {
            "type": "string",
            "examples": [
              "96.00"
            ],
            "description": "The gross value of the exchange before discounts and tax."
          },
          "exchange_discount_total": {
            "type": "string",
            "examples": [
              "0.00"
            ],
            "description": "The total value of discounts on the exchange."
          },
          "exchange_tax_total": {
            "type": "string",
            "examples": [
              "5.28"
            ],
            "description": "The total value of the taxes on the exchange."
          },
          "exchange_total": {
            "type": "string",
            "examples": [
              "101.28"
            ],
            "description": "The net value of the exchanges after discounts and tax."
          },
          "exchange_credit_total": {
            "type": "string",
            "examples": [
              "101.28"
            ],
            "description": "The value of the return credit used by the shopper."
          },
          "upsell": {
            "examples": [
              "0.00"
            ],
            "description": "The upsell amount associated with the return."
          },
          "line_items": {
            "$ref": "#/components/schemas/ReturnDetailsLineItem"
          },
          "customer_email": {
            "type": "string",
            "examples": [
              "email@loopreturns.com"
            ],
            "description": "The customer's email address."
          },
          "carrier": {
            "type": "string",
            "examples": [
              "USPS"
            ],
            "description": "The carrier associated with the return."
          },
          "label_status": {
            "type": "string",
            "examples": [
              "out_for_delivery"
            ],
            "description": "The delivery status of the return."
          },
          "label_updated_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-08-21 14:09:17"
            ],
            "description": "The date and time at which the label was last updated, using the ISO 8601 date format."
          },
          "label_url": {
            "type": "string",
            "examples": [
              "https://test-bucket.s3-us-west-2.amazonaws.com/files/postage_label/01234567/0df7eea6147b44b7ac204e9eb8293cfa.pdf"
            ],
            "description": "The link to the shipping label."
          },
          "label_rate": {
            "type": "string",
            "examples": [
              "250"
            ],
            "description": "The shipping rate paid for the return label."
          },
          "outcome": {
            "outcome": null,
            "$ref": "#/components/schemas/ReturnOutcome",
            "description": "The outcome of the return as limited by the merchant and as selected by the customer."
          },
          "tracking_number": {
            "type": "string",
            "examples": [
              "9999999999999999999999"
            ],
            "description": "The tracking number associated with the return."
          },
          "destination_id": {
            "type": "string",
            "examples": [
              "17"
            ],
            "description": "The unique identifier associated with the return's destination."
          },
          "status_page_url": {
            "type": "string",
            "examples": [
              "https://sample-store.loopreturns.com/#/return/beee8df-b948-4feb-8e23-8cfd2d1e3565"
            ],
            "description": "The link to the return's status page."
          },
          "return_method": {
            "type": "string",
            "examples": [
              "happy-returns"
            ],
            "description": "The return method."
          },
          "package_reference": {
            "type": "string",
            "examples": [
              "9999999999999999999999"
            ],
            "description": "The package reference of the return."
          },
          "shopify_refund_object": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShopifyRefundObject"
            }
          },
          "exchanges": {
            "type": "array",
            "examples": [
              []
            ]
          },
          "customer_first_name": {
            "examples": [
              "Alex"
            ],
            "type": "string"
          },
          "customer_last_name": {
            "examples": [
              "Doe"
            ],
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/Type",
            "description": "The type of return submission."
          },
          "labels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Label"
            }
          }
        }
      },
      "ReturnDetailsLineItem": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "line_item_id": {
              "type": "number",
              "examples": [
                293482039
              ]
            },
            "provider_line_item_id": {
              "type": "number",
              "examples": [
                23984238720
              ]
            },
            "product_id": {
              "type": "number",
              "examples": [
                29871298313
              ]
            },
            "variant_id": {
              "type": "number",
              "examples": [
                23498287203948
              ]
            },
            "sku": {
              "type": "string",
              "examples": [
                "2039473-Y"
              ]
            },
            "line_item_title": {
              "type": "string",
              "examples": [
                "Black Striped Shirt"
              ]
            },
            "variant_title": {
              "type": "string",
              "examples": [
                "Small / Navy"
              ]
            },
            "title": {
              "type": "string",
              "examples": [
                "Black Striped Shirt"
              ]
            },
            "image": {
              "type": "string",
              "examples": [
                "https://cdn.shopify.com/s/files/1/0000/0000/0000/products/Black_Striped_Shirt.jpg"
              ]
            },
            "price": {
              "type": "string",
              "examples": [
                "78.00"
              ]
            },
            "discount": {
              "type": "string",
              "examples": [
                "0.00"
              ]
            },
            "tax": {
              "type": "string",
              "examples": [
                "4.29"
              ]
            },
            "refund": {
              "type": "string",
              "examples": [
                "31.65"
              ]
            },
            "returned_at": {
              "type": "string",
              "format": "date-time",
              "examples": [
                "2023-01-01 22:27:16"
              ],
              "description": "The date and time at which the item was returned, using the ISO 8601 date format."
            },
            "exchange_variant": {
              "type": "string",
              "format": "nullable"
            },
            "barcode": {
              "type": "string",
              "examples": [
                ""
              ]
            },
            "provider_restock_location_id": {
              "type": "string",
              "format": "nullable"
            },
            "consolidation_tracking": {
              "type": "string",
              "format": "nullable",
              "description": "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."
            },
            "reason": {
              "type": "string",
              "examples": [
                "Item was too small"
              ]
            },
            "parent_reason": {
              "type": "string",
              "examples": [
                "Item didn't fit"
              ]
            },
            "refund_tax": {
              "type": "string",
              "examples": [
                "4.29"
              ]
            },
            "refund_item": {
              "type": "string",
              "examples": [
                "27.36"
              ]
            },
            "outcome": {
              "type": "string",
              "enum": [
                "reject",
                "donate",
                "review",
                "default",
                "keep"
              ],
              "examples": [
                "default"
              ]
            },
            "condition": {
              "$ref": "#/components/schemas/Condition"
            },
            "disposition": {
              "$ref": "#/components/schemas/Disposition"
            }
          }
        }
      },
      "NoMatchingReturnDetails": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object"
              },
              "message": {
                "type": "string",
                "examples": [
                  "No return found with this ID."
                ]
              }
            }
          }
        }
      },
      "ReturnDetailsMissingParameters": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object"
              },
              "message": {
                "type": "string",
                "examples": [
                  "Missing parameter. Please pass in: return_id, order_name, or order_id."
                ]
              }
            }
          }
        }
      },
      "ReturnOutcome": {
        "type": "string",
        "enum": [
          "exchange",
          "upsell",
          "refund",
          "credit",
          "exchange+refund",
          "exchange+credit"
        ]
      },
      "Refunds": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "gateway": {
              "type": "string",
              "examples": [
                "Stripe"
              ]
            },
            "amount": {
              "type": "string",
              "examples": [
                "78.00"
              ]
            },
            "currency": {
              "type": "string",
              "examples": [
                "USD"
              ]
            },
            "provider_refund_id": {
              "type": "string",
              "examples": [
                "12345"
              ]
            }
          }
        }
      },
      "Condition": {
        "type": "object",
        "format": "nullable",
        "properties": {
          "description": {
            "type": "string",
            "examples": [
              "Grade A: No refurbishment needed"
            ]
          },
          "condition_category": {
            "type": "string",
            "format": "nullable",
            "enum": [
              "grade_a",
              "grade_b",
              "grade_c",
              "grade_d",
              "incorrect_item",
              "missing",
              "junk"
            ],
            "examples": [
              "grade_c"
            ]
          },
          "return_processor": {
            "type": "string",
            "format": "nullable",
            "examples": [
              "warehouse-operator@example.com"
            ]
          },
          "note": {
            "type": "string",
            "format": "nullable",
            "examples": [
              "This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."
            ]
          },
          "inspected_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-07-19T15:11:32+00:00"
            ]
          },
          "images": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Image"
            }
          }
        }
      },
      "Disposition": {
        "type": "object",
        "format": "nullable",
        "properties": {
          "disposition_outcome": {
            "type": "string",
            "enum": [
              "back_to_stock",
              "resale_hold",
              "recycle",
              "donate",
              "missing"
            ]
          },
          "return_processor": {
            "type": "string",
            "format": "nullable",
            "examples": [
              "warehouse-operator@example.com"
            ]
          },
          "note": {
            "type": "string",
            "format": "nullable",
            "examples": [
              "This item will be returned to stock after bagging and tagging"
            ]
          },
          "inspected_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-07-19T15:11:32+00:00"
            ]
          }
        }
      },
      "Image": {
        "type": "string",
        "format": "uri",
        "examples": [
          "https://example.com/image.jpg"
        ]
      },
      "Type": {
        "type": "string",
        "enum": [
          "standard",
          "warranty"
        ]
      },
      "Label": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "examples": [
              "N/A"
            ],
            "description": "The status of the return shipping label."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-01-01T22:27:18+00:00"
            ],
            "description": "The date and time at which the label was last updated, using the ISO 8601 date format."
          },
          "url": {
            "type": "string",
            "format": "url",
            "examples": [
              "http://example.label.url"
            ],
            "description": "The link to the shipping label details."
          },
          "rate": {
            "type": "integer",
            "format": "nullable",
            "description": "The shipping rate paid for the return label."
          },
          "carrier": {
            "type": "string",
            "examples": [
              "USPS"
            ],
            "description": "The carrier associated with the return."
          },
          "tracking_number": {
            "type": "string",
            "examples": [
              "9999999999999999999999"
            ],
            "description": "The tracking number associated with the return."
          },
          "line_items": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "A list of line item ids associated with the label.",
            "examples": [
              [
                1001,
                1002
              ]
            ]
          }
        }
      },
      "ShopifyRefundObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "examples": [
              1
            ],
            "description": "The unique identifier associated with the refund, assigned by Loop."
          },
          "return_id": {
            "type": "integer",
            "examples": [
              123456789
            ],
            "description": "The unique identifier associated with the return, assigned by Loop."
          },
          "provider_refund_id": {
            "type": "integer",
            "examples": [
              987654321
            ],
            "description": "The unique identifier associated with the refund, assigned by Shopify."
          },
          "provider_created_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-01-01T20:18:04+00:00"
            ],
            "description": "The date and time at which the refund was created in Shopify, using the ISO 8601 date format."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-01-01T22:27:18+00:00"
            ],
            "description": "The date and time at which the refund was created in Loop, using the ISO 8601 date format."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-01-01T22:27:18+00:00"
            ],
            "description": "The date and time at which the refund was last updated in Loop, using the ISO 8601 date format."
          }
        }
      }
    },
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "X-Authorization",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 4,
      "2": 26,
      "3": 60,
      "4": 71,
      "5": 204,
      "6": 200,
      "7": 0,
      "8": 16,
      "9": 223,
      "10": 14,
      "11": 197
    }
  }
}
```