GET v1/Shops/{shopId}/Returns

Get a list with all available Returns, for given shop.

Request Information

Requires Authorization!

URI Parameters

Name	Description	Type	Additional information
shopId	The id of the shop.	integer	Required.
orderId	Optionally specify an id to filter on.	integer	Is Optional. Default value is (null).
code	Optionally specify a code to filter on.	string	Is Optional. Default value is (null).
fromDateCreated	Optionally specify a from date created for returns.	date	Is Optional. Default value is (null).
untilDateCreated	Optionally specify an until date created for returns.	date	Is Optional. Default value is (null).
fromDateChanged	Optionally specify a from date changed for returns.	date	Is Optional. Default value is (null).
untilDateChanged	Optionally specify an until date changed for returns.	date	Is Optional. Default value is (null).
mainStatusId	Optionally specify a main status id to filter on.	integer	Is Optional. Default value is (null).
pageSize	The max number of items returned. Default this value is 100.	integer	Is Optional. Default value is 100.
pageNumber	The page to return. Default page 1 will be returned.	integer	Is Optional. Default value is 1.

Body Parameters

None.

Response Information

Resource Description

A list of the ReturnBasicInfo objects.

Collection of OrderReturnBasicInfo

Name	Type	Additional information
ChangedTimestamp	date	None.
CreatedTimestamp	date	None.
CustomStatusId	integer	None.
Id	integer	None.
MainStatusId	integer	None.
OrderId	integer	None.
ReceivedDate	date	None.
ClosedTimestamp	date	None.
FollowUpTimestamp	date	None.
ReturnCode	string	None.
WarehouseId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ChangedTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "CreatedTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "CustomStatusId": 1,
    "Id": 3,
    "MainStatusId": 1,
    "OrderId": 4,
    "ReceivedDate": "2021-12-02T20:19:38.076032+01:00",
    "ClosedTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "FollowUpTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "ReturnCode": "sample string 5",
    "WarehouseId": 1
  },
  {
    "ChangedTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "CreatedTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "CustomStatusId": 1,
    "Id": 3,
    "MainStatusId": 1,
    "OrderId": 4,
    "ReceivedDate": "2021-12-02T20:19:38.076032+01:00",
    "ClosedTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "FollowUpTimestamp": "2021-12-02T20:19:38.076032+01:00",
    "ReturnCode": "sample string 5",
    "WarehouseId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderReturnBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderReturnBasicInfo>
    <ChangedTimestamp>2021-12-02T20:19:38.076032+01:00</ChangedTimestamp>
    <CreatedTimestamp>2021-12-02T20:19:38.076032+01:00</CreatedTimestamp>
    <CustomStatusId>1</CustomStatusId>
    <Id>3</Id>
    <MainStatusId>1</MainStatusId>
    <OrderId>4</OrderId>
    <ReceivedDate>2021-12-02T20:19:38.076032+01:00</ReceivedDate>
    <ClosedTimestamp>2021-12-02T20:19:38.076032+01:00</ClosedTimestamp>
    <FollowUpTimestamp>2021-12-02T20:19:38.076032+01:00</FollowUpTimestamp>
    <ReturnCode>sample string 5</ReturnCode>
    <WarehouseId>1</WarehouseId>
  </OrderReturnBasicInfo>
  <OrderReturnBasicInfo>
    <ChangedTimestamp>2021-12-02T20:19:38.076032+01:00</ChangedTimestamp>
    <CreatedTimestamp>2021-12-02T20:19:38.076032+01:00</CreatedTimestamp>
    <CustomStatusId>1</CustomStatusId>
    <Id>3</Id>
    <MainStatusId>1</MainStatusId>
    <OrderId>4</OrderId>
    <ReceivedDate>2021-12-02T20:19:38.076032+01:00</ReceivedDate>
    <ClosedTimestamp>2021-12-02T20:19:38.076032+01:00</ClosedTimestamp>
    <FollowUpTimestamp>2021-12-02T20:19:38.076032+01:00</FollowUpTimestamp>
    <ReturnCode>sample string 5</ReturnCode>
    <WarehouseId>1</WarehouseId>
  </OrderReturnBasicInfo>
</ArrayOfOrderReturnBasicInfo>