List return packages

GET /Orders/GetReturnOrderPackages — OMS API · Cancellation & Return

Returns paginated list of return packages filtered. Filter and pagination rules are the same as List order packages (dates in Unix milliseconds, size max 200); additionally can be filtered by isConfirm and rmaCode.

When to call: To match returns received at the warehouse or to monitor return statuses.

Parametreler

  • page (query, integer): Page number (starts from 0).
  • size (query, integer): Page size (maximum 200).
  • startDate (query, integer<int64>): Start time, Unix milliseconds.
  • endDate (query, integer<int64>): End time, Unix milliseconds. If only end is given, start is taken as 7 days before.
  • orderNumber (query, string): Order number.
  • status (query, string): Package status (see OrderPackageStatus).
  • clientStatus (query, string): Client status you set.
  • orderByField (query, string): Sort field (package field name, e.g. orderDate, lastModifiedDate).
  • orderByDirection (query, string): Sort direction; any value other than ASC sorts descending.
  • isConfirm (query, boolean): true for confirmed, false for pending confirmation returns.
  • rmaCode (query, string): Return (RMA) code.

Yanıtlar

  • 200: Query processed. Check the isSuccess field.
  • 400: Body could not be validated (missing required field, type mismatch, or malformed JSON). Response is in ASP.NET Core ValidationProblemDetails format; errors field shows which field is invalid.
  • 401: Authorization header missing, token invalid or expired. Body returns empty; get a new token via /Auth/login.
  • 500: Unexpected server error. This response returns with PascalCase field names (unlike other responses) and includes null fields.

200 yanıt alanları

  • data (ReturnOrderPackageResponse[]): Return packages.
  • pageSize (integer<int32>): Page size.
  • isSuccess (boolean, zorunlu): true if query successful. If no results, returns false and a message.
  • statusCode (string): "200" on successful query.
  • totalPages (integer<int32>): Total pages.
  • currentPage (integer<int32>): Returned page (starts from 0).
  • resultCount (integer<int32>): Number of records on this page.
  • errorMesssage (string): Error message. Returned only if there is an error.
  • totalResultCount (integer<int32>): Total records matching the filter.