---
updatedAt: 2025-09-24T02:25:43.000Z
agentTools:
  projectIndex: https://developer.fastspring.com/llms.txt
---

# Retrieve a return

Retrieves the details of one or more returns.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Sample",
    "version": "1.0",
    "title": "FastSpring API - Returns",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.fastspring.com"
    }
  ],
  "security": [
    {
      "auth": []
    }
  ],
  "tags": [
    {
      "name": "Returns",
      "description": "Creates an order return request for full, partial, or combined refunds and returns processing details for each requested return.\n"
    }
  ],
  "paths": {
    "/returns/{return_id}": {
      "get": {
        "summary": "Retrieve a return",
        "tags": [
          "Returns"
        ],
        "operationId": "Getoneormultiplereturns",
        "deprecated": false,
        "description": "Retrieves the details of one or more returns.",
        "parameters": [
          {
            "name": "return_id",
            "in": "path",
            "required": true,
            "description": "Unique identifier to reference a specific return.",
            "example": "aBCDE12fGH3iJkL4mNOpqr",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetReturnsResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "auth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "GetReturnsResponse": {
        "type": "object",
        "properties": {
          "returns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "return": {
                  "type": "string",
                  "description": "Unique identifier to reference a specific return.",
                  "example": "aBCDE12fGH3iJkL4mNOpqr"
                },
                "quote": {
                  "type": "string",
                  "description": "Quote identifier associated with the return, if any.",
                  "nullable": true,
                  "example": null
                },
                "reference": {
                  "type": "string",
                  "description": "Reference code for the return.",
                  "example": "ABC1234567-8910-11121D"
                },
                "completed": {
                  "type": "boolean",
                  "description": "Indicates whether the return process has been completed.",
                  "example": true
                },
                "changed": {
                  "type": "number",
                  "description": "Timestamp indicating when the return was last changed.",
                  "example": 1731381500223
                },
                "changedValue": {
                  "type": "number",
                  "description": "Value representing when the return was changed.",
                  "example": 1731381500223
                },
                "changedInSeconds": {
                  "type": "number",
                  "description": "Timestamp in seconds indicating when the return was changed.",
                  "example": 1731381500
                },
                "changedDisplay": {
                  "type": "string",
                  "description": "Formatted display date for when the return was changed.",
                  "example": "11/12/24"
                },
                "changedDisplayISO8601": {
                  "type": "string",
                  "format": "date",
                  "description": "ISO8601 formatted date for when the return was changed.",
                  "example": "2024-11-12"
                },
                "live": {
                  "type": "boolean",
                  "description": "Indicates if the return is live.",
                  "example": false
                },
                "account": {
                  "type": "string",
                  "description": "Identifier for the account associated with the return.",
                  "example": "abCdE1FGH2Hij3KLMnOpqR"
                },
                "currency": {
                  "type": "string",
                  "description": "Currency of the return amount.",
                  "example": "USD"
                },
                "payoutCurrency": {
                  "type": "string",
                  "description": "Currency in which the payout is made.",
                  "example": "USD"
                },
                "totalReturn": {
                  "type": "number",
                  "description": "Total return amount.",
                  "example": 5
                },
                "totalReturnDisplay": {
                  "type": "string",
                  "description": "Formatted display of the total return amount.",
                  "example": "$5.00"
                },
                "totalReturnInPayoutCurrency": {
                  "type": "number",
                  "description": "Total return amount in payout currency.",
                  "example": 5
                },
                "totalReturnInPayoutCurrencyDisplay": {
                  "type": "string",
                  "description": "Formatted display of the total return amount in payout currency.",
                  "example": "$5.00"
                },
                "tax": {
                  "type": "number",
                  "description": "Tax amount on the return.",
                  "example": 0
                },
                "taxDisplay": {
                  "type": "string",
                  "description": "Formatted display of the tax amount on the return.",
                  "example": "$0.00"
                },
                "taxInPayoutCurrency": {
                  "type": "number",
                  "description": "Tax amount in payout currency.",
                  "example": 0
                },
                "taxInPayoutCurrencyDisplay": {
                  "type": "string",
                  "description": "Formatted display of the tax amount in payout currency.",
                  "example": "$0.00"
                },
                "subtotal": {
                  "type": "number",
                  "description": "Subtotal amount of the return.",
                  "example": 5
                },
                "subtotalDisplay": {
                  "type": "string",
                  "description": "Formatted display of the subtotal amount.",
                  "example": "$5.00"
                },
                "subtotalInPayoutCurrency": {
                  "type": "number",
                  "description": "Subtotal amount in payout currency.",
                  "example": 5
                },
                "subtotalInPayoutCurrencyDisplay": {
                  "type": "string",
                  "description": "Formatted display of the subtotal amount in payout currency.",
                  "example": "$5.00"
                },
                "totalRefundInPayoutCurrency": {
                  "type": "number",
                  "description": "Total refund amount in payout currency.",
                  "example": 5
                },
                "payment": {
                  "type": "object",
                  "description": "Payment details associated with the return.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Type of payment.",
                      "example": "test"
                    },
                    "cardEnding": {
                      "type": "string",
                      "description": "Last four digits of the card used for the payment.",
                      "example": "4242"
                    }
                  }
                },
                "reason": {
                  "type": "string",
                  "description": "Reason for the return.",
                  "example": "Duplicate Order"
                },
                "note": {
                  "type": "string",
                  "description": "Additional notes regarding the return.",
                  "example": "As requested by customer"
                },
                "type": {
                  "type": "string",
                  "description": "Type of the return.",
                  "example": "RETURN"
                },
                "refundPerformerType": {
                  "type": "string",
                  "description": "Type of performer handling the refund.",
                  "example": "api"
                },
                "refundSourceComponent": {
                  "type": "string",
                  "description": "Source component of the refund.",
                  "example": "refund"
                },
                "original": {
                  "type": "object",
                  "description": "Original order details associated with the return.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the original order.",
                      "example": "AbC1D2eFGH34ijklmnopQrs"
                    },
                    "order": {
                      "type": "string",
                      "description": "Order identifier.",
                      "example": "AbC1D2eFGH34ijklmnopQrs"
                    },
                    "reference": {
                      "type": "string",
                      "description": "Reference code for the original order.",
                      "example": "ABC123456-7891-01112"
                    },
                    "account": {
                      "type": "string",
                      "description": "Account identifier associated with the original order.",
                      "example": "abCdE1FGH2Hij3KLMnOpqR"
                    },
                    "currency": {
                      "type": "string",
                      "description": "Currency of the original order amount.",
                      "example": "USD"
                    },
                    "payoutCurrency": {
                      "type": "string",
                      "description": "Currency in which the payout was made for the original order.",
                      "example": "USD"
                    },
                    "total": {
                      "type": "number",
                      "description": "Total amount of the original order.",
                      "example": 10
                    },
                    "totalDisplay": {
                      "type": "string",
                      "description": "Formatted display of the total amount of the original order.",
                      "example": "$10.00"
                    },
                    "totalInPayoutCurrency": {
                      "type": "number",
                      "description": "Total amount in payout currency of the original order.",
                      "example": 10
                    },
                    "totalInPayoutCurrencyDisplay": {
                      "type": "string",
                      "description": "Formatted display of the total amount in payout currency of the original order.",
                      "example": "$10.00"
                    },
                    "tax": {
                      "type": "number",
                      "description": "Tax amount on the original order.",
                      "example": 0
                    },
                    "taxDisplay": {
                      "type": "string",
                      "description": "Formatted display of the tax amount on the original order.",
                      "example": "$0.00"
                    },
                    "taxInPayoutCurrency": {
                      "type": "number",
                      "description": "Tax amount in payout currency for the original order.",
                      "example": 0
                    },
                    "taxInPayoutCurrencyDisplay": {
                      "type": "string",
                      "description": "Formatted display of the tax amount in payout currency for the original order.",
                      "example": "$0.00"
                    },
                    "subtotal": {
                      "type": "number",
                      "description": "Subtotal amount of the original order.",
                      "example": 10
                    },
                    "subtotalDisplay": {
                      "type": "string",
                      "description": "Formatted display of the subtotal amount of the original order.",
                      "example": "$10.00"
                    },
                    "subtotalInPayoutCurrency": {
                      "type": "number",
                      "description": "Subtotal amount in payout currency of the original order.",
                      "example": 10
                    },
                    "subtotalInPayoutCurrencyDisplay": {
                      "type": "string",
                      "description": "Formatted display of the subtotal amount in payout currency of the original order.",
                      "example": "$10.00"
                    },
                    "notes": {
                      "type": "array",
                      "description": "List of notes associated with the original order.",
                      "items": {
                        "type": "string"
                      },
                      "example": []
                    },
                    "tags": {
                      "type": "object",
                      "description": "Tags associated with the original order.",
                      "additionalProperties": {
                        "type": "string"
                      },
                      "example": {
                        "TagKey1": "test123",
                        "TagKey2": "TagValue2"
                      }
                    }
                  }
                },
                "customer": {
                  "type": "object",
                  "description": "Customer details associated with the return.",
                  "properties": {
                    "first": {
                      "type": "string",
                      "description": "Customer's first name.",
                      "example": "Jane"
                    },
                    "last": {
                      "type": "string",
                      "description": "Customer's last name.",
                      "example": "Doe"
                    },
                    "email": {
                      "type": "string",
                      "description": "Customer's email address.",
                      "example": "jane.doe@example.com"
                    },
                    "company": {
                      "type": "string",
                      "description": "Customer's company name, if any.",
                      "nullable": true,
                      "example": "Example Company"
                    },
                    "phone": {
                      "type": "string",
                      "description": "Customer's phone number.",
                      "example": "5555551234"
                    },
                    "subscribed": {
                      "type": "boolean",
                      "description": "Indicates if the customer is subscribed.",
                      "example": true
                    }
                  }
                },
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "product": {
                        "type": "string",
                        "description": "Product identifier.",
                        "example": "furious-falcon"
                      },
                      "quantity": {
                        "type": "number",
                        "description": "Quantity of the product returned.",
                        "example": 0
                      },
                      "display": {
                        "type": "string",
                        "description": "Display name of the product.",
                        "example": "Furious Falcon"
                      },
                      "sku": {
                        "type": "string",
                        "description": "SKU of the product.",
                        "nullable": true,
                        "example": "sku-12345"
                      },
                      "refundType": {
                        "type": "string",
                        "description": "Type of refund (e.g., Partial Refund).",
                        "example": "Partial Refund"
                      },
                      "subtotal": {
                        "type": "number",
                        "description": "Subtotal amount for the item.",
                        "example": 5
                      },
                      "subtotalDisplay": {
                        "type": "string",
                        "description": "Formatted display of the subtotal amount.",
                        "example": "$5.00"
                      },
                      "subtotalInPayoutCurrency": {
                        "type": "number",
                        "description": "Subtotal amount in payout currency.",
                        "example": 5
                      },
                      "subtotalInPayoutCurrencyDisplay": {
                        "type": "string",
                        "description": "Formatted display of the subtotal amount in payout currency.",
                        "example": "$5.00"
                      },
                      "attributes": {
                        "type": "object",
                        "description": "Attributes associated with the item.",
                        "additionalProperties": {
                          "type": "string"
                        },
                        "example": {
                          "AttributeKey1": "AttributeValue1",
                          "AttributeKey2": "AttributeValue2"
                        }
                      },
                      "withholdings": {
                        "type": "object",
                        "description": "Withholdings applied to the item.",
                        "properties": {
                          "taxWithholdings": {
                            "type": "boolean",
                            "description": "Indicates if tax is withheld for the item.",
                            "example": false
                          }
                        }
                      }
                    }
                  }
                },
                "refundPerformer": {
                  "type": "string",
                  "description": "Identifier of the performer handling the refund.",
                  "example": "jane.doe@example.com"
                },
                "action": {
                  "type": "string",
                  "description": "Action taken for the refund.",
                  "example": "return.get"
                },
                "result": {
                  "type": "string",
                  "description": "Result of the refund action.",
                  "example": "success"
                }
              }
            }
          }
        }
      }
    }
  }
}
```