1. Shipments
Flype Order API Gulf
  • UAE API Integration Guide
    • Introduction
    • Shipments
      • Service Coverage
        POST
      • Shipments Count
        GET
      • All Shipments
        POST
      • Create Bulk Orders
        POST
      • Schedule Pickup
        POST
      • Shipment Details
        GET
      • Shipment Last Status
        GET
      • Cancel Shipment
        POST
      • Get AirwayBill
        GET
    • Locations
      • Get Cities
      • Get All Countries
    • Webhook
      • Shipment Status Updates Webhook
    • Schemas
      • Error
      • ServiceType
      • TrackingStatusName
      • PickupLocation
      • RecipientAddress
      • pickupLocation
      • Parcel
  1. Shipments

All Shipments

POST
/api/order/AllShipments
Returns shipments filtered by trackingStatusName.

All Shipments - Get shipments by status#

Use this endpoint to retrieve shipments filtered by shipment status.
This endpoint returns a paginated list of shipment records based on the provided trackingStatusName. Optional date filters can also be used to limit results by order creation date.

Required field#

  • trackingStatusName - Shipment status name used to filter the results.

Optional filters#

  • createdFrom - Start date filter for shipment creation date.
  • createdTo - End date filter for shipment creation date.
  • displayStart - Starting index for pagination.
  • displayLength - Number of records to return.

When to use this endpoint#

  • To retrieve shipments with a specific status.
  • To view shipments created within a specific date range.
  • To build shipment lists, operational dashboards, or status-based reports.
  • To paginate through shipment records without loading all results at once.

Important notes#

  • This endpoint returns shipment details, not only counts.
  • The trackingStatusName must use a supported status name such as booked, delivered, cancelled, or to_return_origin.
  • Date filters should be provided in YYYY-MM-DD format.
  • If pagination values are not provided, the default starting point is 0 and the default record length is 10.

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 ********************
or
Body Params application/jsonRequired

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/order/AllShipments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "trackingStatusName": "delivered",
    "createdFrom": "2024-01-01",
    "createdTo": "2024-01-31",
    "displayStart": 0,
    "displayLength": 10
}'

Responses

🟢200
application/json
Successful response
Bodyapplication/json

Examples
{
    "status": "success",
    "data": [
        {
            "trackingNumber": "IV83RWTX7XGH",
            "status": "delivered",
            "orderDate": "2024-01-15T10:30:00.000Z",
            "expectedDelivery": "2024-01-16T18:00:00.000Z",
            "deliverDate": "2024-01-16T15:30:00.000Z",
            "recipient": {
                "name": "John Doe",
                "mobileNumber": "+971501234567",
                "email": "john@gmail.com",
                "address": {
                    "street1": "34 Marasi Dr",
                    "street2": "Apt 4B",
                    "streetNumber": "34",
                    "location": "Dubai",
                    "postalCode": null
                }
            },
            "retailer": {
                "name": "Store Name",
                "externalLocationId": "LOC123456",
                "address": {
                    "street1": "123 Store Street",
                    "street2": "Building A",
                    "streetNumber": "456",
                    "location": "Dubai",
                    "postalCode": null,
                    "latitude": 25.5345,
                    "longitude": 20.45345
                }
            },
            "driver": {
                "idNumber": "TestHXT5JK",
                "name": "Test Emirates",
                "phone": "+971501234567"
            }
        }
    ],
    "totalRecords": 100,
    "displayStart": 0,
    "displayLength": 10
}
🟠401
🟠400
Previous
Shipments Count
Next
Create Bulk Orders
Built with