---
updatedAt: 2025-06-05T21:44:22.000Z
agentTools:
  projectIndex: https://docs.dropboy.com/llms.txt
---

# Order status

## Options in filter

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Key
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        modified
      </td>

      <td style={{ textAlign: "left" }}>
        The date for when the tasks last was changed
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        date
      </td>

      <td style={{ textAlign: "left" }}>
        The date for when the tasks was assigned. If `modified` is set, `date` is ignored
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        contract
      </td>

      <td style={{ textAlign: "left" }}>
        The contract key the orders was created with
      </td>
    </tr>
  </tbody>
</Table>

## Result description

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Key
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        orderId
      </td>

      <td>
        The id of the order
      </td>
    </tr>

    <tr>
      <td>
        taskType
      </td>

      <td>
        What type of task it is. Can be `pickup` or `delivery`
      </td>
    </tr>

    <tr>
      <td>
        status
      </td>

      <td>
        What status the task have. Can be `todo`, `finished`, `failed` or `partial`
      </td>
    </tr>

    <tr>
      <td>
        modified
      </td>

      <td>
        The last time the task list was modified
      </td>
    </tr>

    <tr>
      <td>
        estimated
      </td>

      <td>
        The estimated time of arrival for the task
      </td>
    </tr>

    <tr>
      <td>
        actual
      </td>

      <td>
        The actual time of departure for the task
      </td>
    </tr>

    <tr>
      <td>
        orderNumber
      </td>

      <td>
        The orders order number
      </td>
    </tr>
  </tbody>
</Table>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "track-and-trace",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://api.wuxus.com/public/orders"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/status": {
      "get": {
        "summary": "Order status",
        "description": "",
        "operationId": "get-status",
        "parameters": [
          {
            "name": "APIkey",
            "in": "header",
            "description": "Your company's API key to Wuxus",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter",
            "in": "path",
            "description": "A JSON object containing the search query. For a complete list of searchable keys, look for \"Options in filter\". Syntax Example: {\"date\":\"2022-06-15T15:54:00Z”}",
            "schema": {
              "type": "string",
              "format": "json"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"success\": true,\n    \"errors\": null,\n    \"result\": [\n        {\n            \"orderId\": \"5a31360406a63600144c9fdb\",\n            \"taskType\": \"pickup\",\n            \"status\": \"finished\",\n            \"modified\": \"2017-12-15T09:03:19.880Z\",\n            \"estimated\": \"2017-12-15T12:00:00.000Z\",\n            \"actual\": \"2017-12-15T09:01:21.471Z\",\n            \"orderNumber\": \"TEST-1234\"\n        },\n        {\n            \"orderId\": \"5a31360406a63600144c9fdb\",\n            \"taskType\": \"delivery\",\n            \"status\": \"finished\",\n            \"modified\": \"2017-12-15T09:03:19.880Z\",\n            \"estimated\": \"2017-12-15T09:29:54.471Z\",\n            \"actual\": \"2017-12-15T09:03:18.471Z\",\n            \"orderNumber\": \"TEST-1234\"\n        }\n    ]\n}"
                  },
                  "No tasks found": {
                    "value": "{\n    \"success\": true,\n    \"errors\": null,\n    \"result\": []\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "success": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "errors": {},
                        "result": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "orderId": {
                                "type": "string",
                                "example": "5a31360406a63600144c9fdb"
                              },
                              "taskType": {
                                "type": "string",
                                "example": "pickup"
                              },
                              "status": {
                                "type": "string",
                                "example": "finished"
                              },
                              "modified": {
                                "type": "string",
                                "example": "2017-12-15T09:03:19.880Z"
                              },
                              "estimated": {
                                "type": "string",
                                "example": "2017-12-15T12:00:00.000Z"
                              },
                              "actual": {
                                "type": "string",
                                "example": "2017-12-15T09:01:21.471Z"
                              },
                              "orderNumber": {
                                "type": "string",
                                "example": "TEST-1234"
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "No tasks found",
                      "type": "object",
                      "properties": {
                        "success": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "errors": {},
                        "result": {
                          "type": "array"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```