Find returns

GET

/order-management/return/returns

Required scope: viskan:return:read

Searches for returns in the system.

Parameters

Query parameters

methodOfArrival  string

Multivalued

An optional filter on one/many method of arrivals. For example methodOfArrivals=A09

modifiedAfter  string

Filter on last modification date. Useful for getting delta-changes. More details.

page  integer

The page to search for.

Default value: 1

purchaseNumber  string

An optional filter on a single purchasenumber. For example purchaseNumber=1234

resultsPerPage  integer

The number of results per page. Must be a value between 1 and 200.

returnId  integer

Multivalued

An optional filter on one/many returnId. For example returnId=123&returnId=789

returnNumber  string

Multivalued

An optional filter on one/many returnNumber. For example returnNumber=abc&returnNumber=xyz

searchId  string

The search ID to use for continued pages. Not usable together with any of the filters. More details.

status  enum

Multivalued

Filter on current return status. For example status=CREATED&status=RECEIVED.

Enum: CANCELEDCREATEDRECEIVEDREPORTED

warehouseId  integer

Multivalued

The ids of the warehouse . Mutually exclusive with warehouseNumber

warehouseNumber  string

Multivalued

The number of the warehouse we want returns for. Mutually exclusive with warehouseId

webStoreNumber  string

Multivalued

An optional filter on one/many web store(s) where the order was placed. Only applicable for web orders, subscription based orders and physical store orders are not supported by this filter. For example webStoreNumber=888

Response

The search was successful.