Order Management System (OMS) reached end of support in October 2024.
The documentation available here is intended for historical reference only and is not maintained.
For other Commerce-related documentation, see Adobe Commerce Documentation.

Query Returns

For query returns you have available the repository to make that. This repository follows the Query language protocol like all the other MOM repositories. If you have doubts about the usage please go to the query language docuemntation.

Please find below some examples:

  • Search all the returns associated with an specific order:
{
   "query": {
       "size": 20,
       "criteria": {
           "exp": "eq",
           "args": [
               {"exp": "field", "args": [{"value": "order_id"}]},
               {"value": "000000089"}
           ]
       }
   }
}
  • Search all the returns that are yet pending WH confirmation:
{
   "query": {
       "size": 20,
       "criteria": {
           "exp": "eq",
           "args": [
               {"exp": "field", "args": [{"value": "status"}]},
               {"value": "REQUESTED"}
           ]
       }
   }
}