GET api/returns
Get a list of returns
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| PageSize | integer |
|
|
| CurrentPage | integer |
|
|
| startDate | string |
|
|
| endDate | string |
|
Body Parameters
None
Response Information
Resource Description
ReturnList| Name | Type | Description | Additional information |
|---|---|---|---|
| ClientName | string |
|
|
| ObjectList | Collection of ReturnedOrder |
|
|
| TotalCount | integer |
|
|
| CurrentPage | integer |
|
|
| TotalPages | integer |
|
|
| PageSize | integer |
|
|
| ExecutionTime | integer |
|
|
| ErrorMessage | string |
|
|
| ResultCode | integer |
|
Response Formats
application/json, text/json
Sample:
{
"ClientName": "sample string 1",
"ObjectList": [
{
"ReturnId": 1,
"CreateDateTime": "2025-11-04T04:30:23.9394052+00:00",
"OrderNumber": "sample string 3",
"ReturnReasonID": 4,
"ReturnReason": "sample string 5",
"ProductAmount": 6.1,
"Name": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"Address3": "sample string 10",
"City": "sample string 11",
"State": "sample string 12",
"Zip": "sample string 13",
"CountryId": 14,
"Phone": "sample string 15",
"CurrencyID": 16,
"WarehouseID": 17,
"WarhouseCode": "sample string 18",
"OutgoingWarehouseID": {},
"ReturnStatus": "sample string 25",
"RmaNumber": "sample string 27",
"Warehouse": "sample string 28",
"ModifiedDateTime": "2025-11-04T04:30:23.9394052+00:00",
"OriginalOrderNumber": "sample string 33",
"ReturnFulfillmentItems": [
{
"IsHeavyItem": true,
"ReturnerName": "sample string 4",
"BadQty": 7,
"ReceivedQty": 8,
"AuthorizedQty": 9,
"DisposeItemCount": 10,
"ReturnNotes": "sample string 11",
"RestockQty": 12,
"PartNumber": "sample string 14",
"ReceiveDt": "2025-11-04T04:30:23.9550158+00:00",
"ItemName": "sample string 17",
"SalesPrice": 18.1,
"DamageReason": "sample string 21",
"Lot": "sample string 22",
"ModifiedDateTime": "2025-11-04T04:30:23.9550158+00:00",
"ReturnFulfillmentItemSerials": [
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
},
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
}
],
"ClientName": "sample string 25"
},
{
"IsHeavyItem": true,
"ReturnerName": "sample string 4",
"BadQty": 7,
"ReceivedQty": 8,
"AuthorizedQty": 9,
"DisposeItemCount": 10,
"ReturnNotes": "sample string 11",
"RestockQty": 12,
"PartNumber": "sample string 14",
"ReceiveDt": "2025-11-04T04:30:23.9550158+00:00",
"ItemName": "sample string 17",
"SalesPrice": 18.1,
"DamageReason": "sample string 21",
"Lot": "sample string 22",
"ModifiedDateTime": "2025-11-04T04:30:23.9550158+00:00",
"ReturnFulfillmentItemSerials": [
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
},
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
}
],
"ClientName": "sample string 25"
}
],
"ClientName": "sample string 34"
},
{
"ReturnId": 1,
"CreateDateTime": "2025-11-04T04:30:23.9394052+00:00",
"OrderNumber": "sample string 3",
"ReturnReasonID": 4,
"ReturnReason": "sample string 5",
"ProductAmount": 6.1,
"Name": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"Address3": "sample string 10",
"City": "sample string 11",
"State": "sample string 12",
"Zip": "sample string 13",
"CountryId": 14,
"Phone": "sample string 15",
"CurrencyID": 16,
"WarehouseID": 17,
"WarhouseCode": "sample string 18",
"OutgoingWarehouseID": {},
"ReturnStatus": "sample string 25",
"RmaNumber": "sample string 27",
"Warehouse": "sample string 28",
"ModifiedDateTime": "2025-11-04T04:30:23.9394052+00:00",
"OriginalOrderNumber": "sample string 33",
"ReturnFulfillmentItems": [
{
"IsHeavyItem": true,
"ReturnerName": "sample string 4",
"BadQty": 7,
"ReceivedQty": 8,
"AuthorizedQty": 9,
"DisposeItemCount": 10,
"ReturnNotes": "sample string 11",
"RestockQty": 12,
"PartNumber": "sample string 14",
"ReceiveDt": "2025-11-04T04:30:23.9550158+00:00",
"ItemName": "sample string 17",
"SalesPrice": 18.1,
"DamageReason": "sample string 21",
"Lot": "sample string 22",
"ModifiedDateTime": "2025-11-04T04:30:23.9550158+00:00",
"ReturnFulfillmentItemSerials": [
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
},
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
}
],
"ClientName": "sample string 25"
},
{
"IsHeavyItem": true,
"ReturnerName": "sample string 4",
"BadQty": 7,
"ReceivedQty": 8,
"AuthorizedQty": 9,
"DisposeItemCount": 10,
"ReturnNotes": "sample string 11",
"RestockQty": 12,
"PartNumber": "sample string 14",
"ReceiveDt": "2025-11-04T04:30:23.9550158+00:00",
"ItemName": "sample string 17",
"SalesPrice": 18.1,
"DamageReason": "sample string 21",
"Lot": "sample string 22",
"ModifiedDateTime": "2025-11-04T04:30:23.9550158+00:00",
"ReturnFulfillmentItemSerials": [
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
},
{
"ReturnFulfillmentItemSerialID": 1,
"ReturnFulfillmentItemID": 2,
"ItemID": 3,
"ReturnSerial1": "sample string 4",
"ReturnSerial2": "sample string 5"
}
],
"ClientName": "sample string 25"
}
],
"ClientName": "sample string 34"
}
],
"TotalCount": 2,
"CurrentPage": 3,
"TotalPages": 4,
"PageSize": 5,
"ExecutionTime": 6,
"ErrorMessage": "sample string 7",
"ResultCode": 8
}
application/xml, text/xml
Sample:
<ReturnList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ClientName>sample string 1</ClientName>
<ObjectList>
<ReturnedOrder>
<ReturnId>1</ReturnId>
<CreateDateTime>2025-11-04T04:30:23.9394052+00:00</CreateDateTime>
<OrderNumber>sample string 3</OrderNumber>
<ReturnReasonID>4</ReturnReasonID>
<ReturnReason>sample string 5</ReturnReason>
<ProductAmount>6.1</ProductAmount>
<Name>sample string 7</Name>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<Address3>sample string 10</Address3>
<City>sample string 11</City>
<State>sample string 12</State>
<Zip>sample string 13</Zip>
<CountryId>14</CountryId>
<Phone>sample string 15</Phone>
<CurrencyID>16</CurrencyID>
<WarehouseID>17</WarehouseID>
<WarhouseCode>sample string 18</WarhouseCode>
<OutgoingWarehouseID />
<CurrencyId>20</CurrencyId>
<WarehouseId>21</WarehouseId>
<SourceOrderId>22</SourceOrderId>
<OutgoingWarehouseId />
<NewOrderNumber>sample string 24</NewOrderNumber>
<ReturnStatus>sample string 25</ReturnStatus>
<RmaStatusId>26</RmaStatusId>
<RmaNumber>sample string 27</RmaNumber>
<Warehouse>sample string 28</Warehouse>
<CSessionId>29</CSessionId>
<MSessionId>30</MSessionId>
<ModifiedDateTime>2025-11-04T04:30:23.9394052+00:00</ModifiedDateTime>
<RowVersion>sample string 32</RowVersion>
<OriginalOrderNumber>sample string 33</OriginalOrderNumber>
<ReturnFulfillmentItems>
<Returnfulfillmentitem>
<IsHeavyItem>true</IsHeavyItem>
<ReturnFulfillmentItemId>2</ReturnFulfillmentItemId>
<ReturnId>3</ReturnId>
<ReturnerName>sample string 4</ReturnerName>
<SourceFulfillmentItemId />
<ItemId>6</ItemId>
<BadQty>7</BadQty>
<ReceivedQty>8</ReceivedQty>
<AuthorizedQty>9</AuthorizedQty>
<DisposeItemCount>10</DisposeItemCount>
<ReturnNotes>sample string 11</ReturnNotes>
<RestockQty>12</RestockQty>
<WarehouseId>13</WarehouseId>
<PartNumber>sample string 14</PartNumber>
<ReceiveUserId>15</ReceiveUserId>
<ReceiveDt>2025-11-04T04:30:23.9550158+00:00</ReceiveDt>
<ItemName>sample string 17</ItemName>
<SalesPrice>18.1</SalesPrice>
<MSessionId>19</MSessionId>
<CSessionId>20</CSessionId>
<DamageReason>sample string 21</DamageReason>
<Lot>sample string 22</Lot>
<ModifiedDateTime>2025-11-04T04:30:23.9550158+00:00</ModifiedDateTime>
<RowVersion>sample string 24</RowVersion>
<ReturnFulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
</ReturnFulfillmentItemSerials>
<ClientName>sample string 25</ClientName>
<DBStatus>26</DBStatus>
<ObjStatus>27</ObjStatus>
<TimeStamp>2025-11-04T04:30:23.9550158+00:00</TimeStamp>
</Returnfulfillmentitem>
<Returnfulfillmentitem>
<IsHeavyItem>true</IsHeavyItem>
<ReturnFulfillmentItemId>2</ReturnFulfillmentItemId>
<ReturnId>3</ReturnId>
<ReturnerName>sample string 4</ReturnerName>
<SourceFulfillmentItemId />
<ItemId>6</ItemId>
<BadQty>7</BadQty>
<ReceivedQty>8</ReceivedQty>
<AuthorizedQty>9</AuthorizedQty>
<DisposeItemCount>10</DisposeItemCount>
<ReturnNotes>sample string 11</ReturnNotes>
<RestockQty>12</RestockQty>
<WarehouseId>13</WarehouseId>
<PartNumber>sample string 14</PartNumber>
<ReceiveUserId>15</ReceiveUserId>
<ReceiveDt>2025-11-04T04:30:23.9550158+00:00</ReceiveDt>
<ItemName>sample string 17</ItemName>
<SalesPrice>18.1</SalesPrice>
<MSessionId>19</MSessionId>
<CSessionId>20</CSessionId>
<DamageReason>sample string 21</DamageReason>
<Lot>sample string 22</Lot>
<ModifiedDateTime>2025-11-04T04:30:23.9550158+00:00</ModifiedDateTime>
<RowVersion>sample string 24</RowVersion>
<ReturnFulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
</ReturnFulfillmentItemSerials>
<ClientName>sample string 25</ClientName>
<DBStatus>26</DBStatus>
<ObjStatus>27</ObjStatus>
<TimeStamp>2025-11-04T04:30:23.9550158+00:00</TimeStamp>
</Returnfulfillmentitem>
</ReturnFulfillmentItems>
<ClientName>sample string 34</ClientName>
<DBStatus>35</DBStatus>
<ObjStatus>36</ObjStatus>
<TimeStamp>2025-11-04T04:30:23.9550158+00:00</TimeStamp>
</ReturnedOrder>
<ReturnedOrder>
<ReturnId>1</ReturnId>
<CreateDateTime>2025-11-04T04:30:23.9394052+00:00</CreateDateTime>
<OrderNumber>sample string 3</OrderNumber>
<ReturnReasonID>4</ReturnReasonID>
<ReturnReason>sample string 5</ReturnReason>
<ProductAmount>6.1</ProductAmount>
<Name>sample string 7</Name>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<Address3>sample string 10</Address3>
<City>sample string 11</City>
<State>sample string 12</State>
<Zip>sample string 13</Zip>
<CountryId>14</CountryId>
<Phone>sample string 15</Phone>
<CurrencyID>16</CurrencyID>
<WarehouseID>17</WarehouseID>
<WarhouseCode>sample string 18</WarhouseCode>
<OutgoingWarehouseID />
<CurrencyId>20</CurrencyId>
<WarehouseId>21</WarehouseId>
<SourceOrderId>22</SourceOrderId>
<OutgoingWarehouseId />
<NewOrderNumber>sample string 24</NewOrderNumber>
<ReturnStatus>sample string 25</ReturnStatus>
<RmaStatusId>26</RmaStatusId>
<RmaNumber>sample string 27</RmaNumber>
<Warehouse>sample string 28</Warehouse>
<CSessionId>29</CSessionId>
<MSessionId>30</MSessionId>
<ModifiedDateTime>2025-11-04T04:30:23.9394052+00:00</ModifiedDateTime>
<RowVersion>sample string 32</RowVersion>
<OriginalOrderNumber>sample string 33</OriginalOrderNumber>
<ReturnFulfillmentItems>
<Returnfulfillmentitem>
<IsHeavyItem>true</IsHeavyItem>
<ReturnFulfillmentItemId>2</ReturnFulfillmentItemId>
<ReturnId>3</ReturnId>
<ReturnerName>sample string 4</ReturnerName>
<SourceFulfillmentItemId />
<ItemId>6</ItemId>
<BadQty>7</BadQty>
<ReceivedQty>8</ReceivedQty>
<AuthorizedQty>9</AuthorizedQty>
<DisposeItemCount>10</DisposeItemCount>
<ReturnNotes>sample string 11</ReturnNotes>
<RestockQty>12</RestockQty>
<WarehouseId>13</WarehouseId>
<PartNumber>sample string 14</PartNumber>
<ReceiveUserId>15</ReceiveUserId>
<ReceiveDt>2025-11-04T04:30:23.9550158+00:00</ReceiveDt>
<ItemName>sample string 17</ItemName>
<SalesPrice>18.1</SalesPrice>
<MSessionId>19</MSessionId>
<CSessionId>20</CSessionId>
<DamageReason>sample string 21</DamageReason>
<Lot>sample string 22</Lot>
<ModifiedDateTime>2025-11-04T04:30:23.9550158+00:00</ModifiedDateTime>
<RowVersion>sample string 24</RowVersion>
<ReturnFulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
</ReturnFulfillmentItemSerials>
<ClientName>sample string 25</ClientName>
<DBStatus>26</DBStatus>
<ObjStatus>27</ObjStatus>
<TimeStamp>2025-11-04T04:30:23.9550158+00:00</TimeStamp>
</Returnfulfillmentitem>
<Returnfulfillmentitem>
<IsHeavyItem>true</IsHeavyItem>
<ReturnFulfillmentItemId>2</ReturnFulfillmentItemId>
<ReturnId>3</ReturnId>
<ReturnerName>sample string 4</ReturnerName>
<SourceFulfillmentItemId />
<ItemId>6</ItemId>
<BadQty>7</BadQty>
<ReceivedQty>8</ReceivedQty>
<AuthorizedQty>9</AuthorizedQty>
<DisposeItemCount>10</DisposeItemCount>
<ReturnNotes>sample string 11</ReturnNotes>
<RestockQty>12</RestockQty>
<WarehouseId>13</WarehouseId>
<PartNumber>sample string 14</PartNumber>
<ReceiveUserId>15</ReceiveUserId>
<ReceiveDt>2025-11-04T04:30:23.9550158+00:00</ReceiveDt>
<ItemName>sample string 17</ItemName>
<SalesPrice>18.1</SalesPrice>
<MSessionId>19</MSessionId>
<CSessionId>20</CSessionId>
<DamageReason>sample string 21</DamageReason>
<Lot>sample string 22</Lot>
<ModifiedDateTime>2025-11-04T04:30:23.9550158+00:00</ModifiedDateTime>
<RowVersion>sample string 24</RowVersion>
<ReturnFulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
<ReturnfulfillmentItemSerials>
<ReturnFulfillmentItemSerialID>1</ReturnFulfillmentItemSerialID>
<ReturnFulfillmentItemID>2</ReturnFulfillmentItemID>
<ItemID>3</ItemID>
<ReturnSerial1>sample string 4</ReturnSerial1>
<ReturnSerial2>sample string 5</ReturnSerial2>
<ClientName>sample string 6</ClientName>
<DBStatus>7</DBStatus>
<ObjStatus>8</ObjStatus>
</ReturnfulfillmentItemSerials>
</ReturnFulfillmentItemSerials>
<ClientName>sample string 25</ClientName>
<DBStatus>26</DBStatus>
<ObjStatus>27</ObjStatus>
<TimeStamp>2025-11-04T04:30:23.9550158+00:00</TimeStamp>
</Returnfulfillmentitem>
</ReturnFulfillmentItems>
<ClientName>sample string 34</ClientName>
<DBStatus>35</DBStatus>
<ObjStatus>36</ObjStatus>
<TimeStamp>2025-11-04T04:30:23.9550158+00:00</TimeStamp>
</ReturnedOrder>
</ObjectList>
<TotalCount>2</TotalCount>
<CurrentPage>3</CurrentPage>
<TotalPages>4</TotalPages>
<PageSize>5</PageSize>
<ExecutionTime>6</ExecutionTime>
<ErrorMessage>sample string 7</ErrorMessage>
<ResultCode>8</ResultCode>
</ReturnList>