order

Order - Get Shipped

Changed on

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

get/order/get_shipped

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/order/get_shipped
  • Auth
    HTTP bearer

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

warehousesstring[]

Filter by warehouse IDs (matches order.warehouse_id or stash.items.fulfillment_warehouse_id)

fulfillment_warehousesstring[]

Filter by geo-routed fulfillment warehouse IDs (matches stash.items.fulfillment_warehouse_id only — unlike warehouses, ignores order-level warehouse_id)

shipping_methodsstring[]

Filter by requested shipping method names

type'include' | 'exclude' required
criteria'store' | 'tag' | 'status' required
valuestring required

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",
        "ship_by_date": "2025-01-17T23:59:59.000Z"
      },
      "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"
    }
  ]
}

Changes

  • 3bf9d805a276Revision changes
    • info

      added the new optional query request parameter advanced_filters

    • info

      added the new optional query request parameter fulfillment_warehouses

    • info

      added the new optional query request parameter shipping_methods

    • info

      added the new optional query request parameter warehouses

    • info

      added the optional property /// to the response with the status

  • fa53dd949b8eRevision changes
    • breaking

      the query request parameter end became required

    • breaking

      the query request parameter start became required

    • info

      api operation id get_order_get_shipped was added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status