All Shipments

All Shipments - Retrieve shipments by status

Use this endpoint to retrieve shipments filtered by shipment status, creation date, and pagination parameters.

This endpoint is useful for dashboards, reporting, reconciliation, and operational monitoring.

Status filtering

Use trackingStatusName to filter shipments by status. Status names are returned in lowercase snake_case format.

Pagination

displayStart controls the starting index.
displayLength controls the number of records returned.

Important notes

If no shipments match the filters, the API returns an empty data array.
Date filters apply to the order creation date unless otherwise specified.
Use Shipment Details to retrieve the full tracking history for a specific shipment.

Returns shipments filtered by trackingStatusName.

Status names are lowercase snake_case.

Supported shipment statuses

Creation

booked - order created

DC / Sorting

to_dc_truck_transit - picked up by Flype, In transit to DC

at_dc - order landed at Flype distribution center

Delivery

to_delivery - Out for delivery

delivery_attempt_failed - Delivery attempt failed

delivery_reattempt - Reattempt scheduled

delivered - Delivered

Returns to Flype DC

to_return - order in transit to Flype distribution center (after failed delivery attempt)

returned - Returned - order returned to Flype distribution center (after failed delivery attempt)

Exceptions / issues with order

undeliverable - Undeliverable (address not valid, recipient refused order, or failure after maximum allowed delivery attempts)

delayed - Delayed (to be rescheduled for delivery reattempt)

Returns to origin

to_return_origin - Returning to origin pickup location

in_transit_to_return_origin - order loaded in truck and on the way to the origin pickup point

returned_origin - Returned to origin pickup point

Cancellation

cancelled - Cancelled

Pagination: displayStart (default 0), displayLength (default 10).

Headers:

Authorization: Bearer <static_token>

Content-Type: application/json (for POST)

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Delivered ordersOrders out for delivery

{
    "trackingStatusName": "delivered",
    "createdFrom": "2024-01-01",
    "createdTo": "2024-01-31",
    "displayStart": 0,
    "displayLength": 10
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Shipments list.

Bodyapplication/json

Examples

Delivered ordersOrders out for delivery

{
    "status": "success",
    "data": [
        {
            "trackingNumber": "TKTN0M4DVCJ8",
            "status": "delivered",
            "orderDate": "2024-01-02T18:06:27.816Z",
            "expectedDelivery": "2024-01-02T18:06:27.816Z",
            "deliveryDate": "2024-01-02T18:13:22.816Z",
            "recipient": {
                "name": "Chad McGlynn",
                "mobileNumber": "13026051809",
                "address": {
                    "postalCode": "04102",
                    "city": "New York",
                    "street1": "368 Clinton Street",
                    "street2": "38A",
                    "streetNumber": "368",
                    "latitude": 62.7059,
                    "longitude": -155.8939,
                    "rdi": 1
                }
            },
            "retailer": {
                "name": "Walmart",
                "externalLocationId": "LOC123468",
                "address": {
                    "postalCode": "23055-6876",
                    "city": "New York",
                    "street1": "38437 Halvorson Squares",
                    "street2": "Building 3",
                    "streetNumber": "38437",
                    "latitude": -47.1954,
                    "longitude": -40.9939
                }
            },
            "driver": {
                "idNumber": "AleHTFY567",
                "name": "Alexandra Fahey"
            }
        },
        {
            "trackingNumber": "ONRNQM4DVCJ8",
            "status": "delivered",
            "orderDate": "2024-01-03",
            "expectedDelivery": "2024-01-03T18:06:27.816Z",
            "failMoment": null,
            "deliverDate": "2024-01-03T18:13:22.816Z",
            "recipient": {
                "name": "John Mcain",
                "mobileNumber": "13026051803",
                "address": {
                    "postalCode": "10019",
                    "city": "New York",
                    "street1": "334 west 51st street",
                    "street2": "APT 11B",
                    "streetNumber": "334",
                    "latitude": 62.7059,
                    "longitude": -155.8939,
                    "rdi": 1
                }
            },
            "retailer": {
                "name": "Walmart",
                "externalLocationId": "LOC123468",
                "address": {
                    "postalCode": "23055-6876",
                    "city": "New York",
                    "street1": "38437 Halvorson Squares",
                    "street2": "Building 3",
                    "streetNumber": "38437",
                    "latitude": -47.1954,
                    "longitude": -40.9939
                }
            },
            "driver": {
                "idNumber": "LOUHTFY567",
                "name": "Louis Castro"
            }
        }
    ],
    "totalRecords": 2,
    "displayStart": 0,
    "displayLength": 10
}

🟠401

🔴500

All Shipments - Retrieve shipments by status#

Status filtering#

Pagination#

Important notes#

Supported shipment statuses#