Flype Order API
  1. Shipments
  • Flype Order API
    • Shipments
      • Rates
        POST
      • Shipments Count
        GET
      • All Shipments
        POST
      • Bulk Order
        POST
      • Shipment Details
        GET
      • Shipment Last Status
        GET
      • Cancel Shipment
        GET
      • Get Shipping label
        GET
    • Webhook
      • Webhook: Shipment status updates (Flype → Your Server)
    • Schemas
      • ApiStatus
      • ErrorResponse
      • ShipmentsCountResponse
      • AllShipmentsRequest
      • ShipmentSummary
      • AllShipmentsResponse
      • BulkOrderRequest
      • BulkOrderResponse
      • SchedulePickupRequest
      • SchedulePickupResponse
      • City
      • GetCitiesResponse
      • ShipmentDetailsResponse
      • ShipmentLastStatusResponse
      • CancelShipmentResponse
      • LabelResponse
      • Country
      • CountriesResponse
      • ShipmentStatusWebhook
      • PlaceBulkItem
      • SuccessMessageResponse
      • PlaceBulkAddress
      • BooleanDataResponse
      • PlaceBulkPickupLocation
      • ShipmentAddress
      • PlaceBulkShipment
      • ShipmentRecipient
      • PlaceBulkAcceptedOrder
      • ShipmentRetailerAddress
      • PlaceBulkDeniedOrder
      • ShipmentRetailer
      • BulkOrderResponseData
      • ShipmentDriver
      • ShipmentStatusHistoryEntry
      • DeliverySettings
      • DropOffDetails
      • AllShipmentsItem
      • CitiesResponse
      • AirwayBillResponse
      • WebhookShipmentStatusUpdate
      • WebhookAckResponse
      • PlaceBulkDeliveryAddress
      • PlaceBulkRequest
  1. Shipments

All Shipments

POST
/order/AllShipments
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
at_delivery - Driver is at delivery location
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
returned - Returned - order returned to Flype distribution center
** Exceptions / issues with order **
undeliverable - Undeliverable (address not valid, recipient refused order or any other valid reason)
delayed - Delayed (to be rescheduled for delivery reattempt
** Returns to origin **
to_return_origin - Returning to origin
in_transit_to_return_origin - order loaded in truck and on the way to return origin pickup point
returned_origin - Returned to origin
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 ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Shipments list.
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST '/order/AllShipments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "trackingStatusName": "delivered",
    "createdFrom": "2024-01-01",
    "createdTo": "2024-01-31",
    "displayStart": 0,
    "displayLength": 10
}'
Response Response Example
200 - Delivered orders
{
    "data": [
        {
            "trackingNumber": "TKTN0M4DVCJ8",
            "status": "delivered",
            "orderDate": "2024-01-02",
            "expectedDelivery": "2024-01-02T18:06:27.816Z",
            "failMoment": null,
            "deliverDate": "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
}
Previous
Shipments Count
Next
Bulk Order
Built with