v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

order

Order - Get Shipped

Retrieve shipped orders with optional filtering by date range and store.

get/order/get_shipped

Query parameters

startstring date required

Start date

Example:2024-01-01

endstring date required

End date

Example:2024-12-31

tagsstring[]

Filter by tag IDs (ObjectId strings referencing the tag collection)

[
  "507f1f77bcf86cd799439011"
]

store_idsstring[]

Filter by store IDs

Response

Shipped orders

db_timenumber

Query execution time (ms)

process_timenumber

Processing time (ms)

messagestring

Limit warning message if result was truncated

Example response

{
  "orders": [
    {
      "store_id": "507f1f77bcf86cd799439011",
      "stash": {
        "store_id": "507f1f77bcf86cd799439011",
        "date": "2025-01-15"
      },
      "log": [
        {
          "user_id": "507f1f77bcf86cd799439011",
          "time": "2025-01-15T12:00:00.000Z"
        }
      ],
      "shipments": [
        {
          "_id": "507f1f77bcf86cd799439011",
          "user_id": "507f1f77bcf86cd799439011",
          "time": "2025-01-15T12:00:00.000Z"
        }
      ],
      "notes": [
        {
          "_id": "507f1f77bcf86cd799439011",
          "user_id": "507f1f77bcf86cd799439011",
          "time": "2025-01-15T12:00:00.000Z"
        }
      ],
      "shipped_date": "2025-01-15T12:00:00.000Z",
      "last_shipment_date": "2025-01-15T12:00:00.000Z",
      "tags": [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012"
      ],
      "date": "2025-01-15"
    }
  ]
}