GET orders/{orderNumber}/returns

Return list of returns for a given order number

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderNumber integer Required

Body Parameters

None.

Response Information

Resource Description

Return list of returns for a given order number

Collection of OrderReturnModel
NameDescriptionTypeAdditional information
OrderReturnId integer None.
ReturnReasonId integer None.
ReturnReason string None.
ReturnDate date None.
Comments string None.
ReturnedById integer None.
QtyReturned integer None.
RefundAmount decimal number None.
ReturnToInventory boolean None.
ReturnStockLocationId integer None.
ShippingAmountRefunded decimal number None.
ProductId integer None.
ProductSKU string None.
ProductName string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OrderReturnId": 1,
    "ReturnReasonId": 1,
    "ReturnReason": "sample string 2",
    "ReturnDate": "2025-06-27T10:19:34.53398+00:00",
    "Comments": "sample string 3",
    "ReturnedById": 1,
    "QtyReturned": 1,
    "RefundAmount": 1.0,
    "ReturnToInventory": true,
    "ReturnStockLocationId": 1,
    "ShippingAmountRefunded": 4.0,
    "ProductId": 1,
    "ProductSKU": "sample string 5",
    "ProductName": "sample string 6"
  },
  {
    "OrderReturnId": 1,
    "ReturnReasonId": 1,
    "ReturnReason": "sample string 2",
    "ReturnDate": "2025-06-27T10:19:34.53398+00:00",
    "Comments": "sample string 3",
    "ReturnedById": 1,
    "QtyReturned": 1,
    "RefundAmount": 1.0,
    "ReturnToInventory": true,
    "ReturnStockLocationId": 1,
    "ShippingAmountRefunded": 4.0,
    "ProductId": 1,
    "ProductSKU": "sample string 5",
    "ProductName": "sample string 6"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOrderReturnModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderReturnModel>
    <OrderReturnId>1</OrderReturnId>
    <ReturnReasonId>1</ReturnReasonId>
    <ReturnReason>sample string 2</ReturnReason>
    <ReturnDate>2025-06-27T10:19:34.53398+00:00</ReturnDate>
    <Comments>sample string 3</Comments>
    <ReturnedById>1</ReturnedById>
    <QtyReturned>1</QtyReturned>
    <RefundAmount>1</RefundAmount>
    <ReturnToInventory>true</ReturnToInventory>
    <ReturnStockLocationId>1</ReturnStockLocationId>
    <ShippingAmountRefunded>4</ShippingAmountRefunded>
    <ProductId>1</ProductId>
    <ProductSKU>sample string 5</ProductSKU>
    <ProductName>sample string 6</ProductName>
  </OrderReturnModel>
  <OrderReturnModel>
    <OrderReturnId>1</OrderReturnId>
    <ReturnReasonId>1</ReturnReasonId>
    <ReturnReason>sample string 2</ReturnReason>
    <ReturnDate>2025-06-27T10:19:34.53398+00:00</ReturnDate>
    <Comments>sample string 3</Comments>
    <ReturnedById>1</ReturnedById>
    <QtyReturned>1</QtyReturned>
    <RefundAmount>1</RefundAmount>
    <ReturnToInventory>true</ReturnToInventory>
    <ReturnStockLocationId>1</ReturnStockLocationId>
    <ShippingAmountRefunded>4</ShippingAmountRefunded>
    <ProductId>1</ProductId>
    <ProductSKU>sample string 5</ProductSKU>
    <ProductName>sample string 6</ProductName>
  </OrderReturnModel>
</ArrayOfOrderReturnModel>