Get order filter list

Authentication: This method requires authentication.

Summary

Get Order List Filters

Description

This method retrieves a list of possible order filters. This filters may be used in the Get order list method.

Parameters

This method does not require any parameters.

Response

The response data is an array of objects of this structure:

title: string: Filter title (can be used for selector visualize)
value: string: Filter value (you need to pass this string into request for filtering)

Good Response example

{
  "status": "ok",
  "statusCode": 200,
  "data": [
    {
      "title": "Out of stock",
      "value": "out_of_stock"
    },
    {
      "title": "Waiting to be assigned",
      "value": "awaiting_assigned"
    },
    {
      "title": "Assigned",
      "value": "assigned"
    },
    {
      "title": "Completed",
      "value": "completed"
    },
    {
      "title": "Reviewed",
      "value": "reviewed"
    }
  ]
}

Bad Response Examples

http code	response example
`401`	see 401 Unauthorized
`422`	see 422 ValidationError

Last modified: 09 February 2024