List shipments

POST

/api/order/AllShipments

Your orders that have a given latest status, newest first, one page at a time. createdFrom and createdTo limit the order date (calendar days, both included). Read the next page by raising displayStart by displayLength until displayStart reaches totalRecords.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "trackingStatusName": "booked",
    "createdFrom": "2026-10-01",
    "createdTo": "2026-10-27",
    "displayStart": 0,
    "displayLength": 25
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://flype-ops-panel-dev.web.app/api/order/AllShipments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "trackingStatusName": "booked",
    "createdFrom": "2026-10-01",
    "createdTo": "2026-10-27",
    "displayStart": 0,
    "displayLength": 25
}'

Responses

🟢200

application/json

One page of orders.

Bodyapplication/json

Example

{
    "status": "success",
    "data": [
        {
            "trackingNumber": "IFZKGGUQZLAA",
            "shipperRef": "SHOP-10459",
            "status": "booked",
            "orderNumber": 2902925,
            "serviceType": "NEXT_DAY",
            "packages": 1,
            "orderDate": "2026-10-27T13:40:21.000Z",
            "pickupDate": "2026-10-27",
            "pickupTime": "2026-10-28T04:30:00.000Z",
            "expectedDeliveryDate": "2026-10-28",
            "signatureRequired": false,
            "ageVerification": false,
            "deliveredAt": null,
            "trackingUrl": "https://track.example.com/ca/IFZKGGUQZLAA",
            "price": {
                "total": 10,
                "tax": 0,
                "currency": "CAD"
            },
            "recipient": {
                "name": "Sam Lee",
                "mobileNumber": "+14165550102",
                "email": null,
                "address": {
                    "street1": "290 Bremner Blvd",
                    "street2": null,
                    "streetNumber": null,
                    "postalCode": "M5V 3L9",
                    "location": "Toronto",
                    "province": "ON",
                    "latitude": 43.6426,
                    "longitude": -79.3871
                }
            },
            "retailer": {
                "name": "Main Warehouse",
                "externalLocationId": "ITPU1",
                "address": {
                    "street1": "290 Bremner Blvd",
                    "street2": null,
                    "postalCode": "M5V 3L9",
                    "location": "Toronto",
                    "latitude": 43.6532,
                    "longitude": -79.3832
                }
            },
            "driver": null
        }
    ],
    "totalRecords": 1056,
    "displayStart": 0,
    "displayLength": 25
}

🟠400

🟠401Unauthorized

🟠403Forbidden

Modified at 2026-10-28 04:52:40

Get shipments count

Get label