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

Shipments Count

GET
/order/ShipmentsCount
Returns total counts of shipments separated by status.
Note: totalToBeDelivered includes active delivery and some return/failed statuses.
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

Responses

🟢200
application/json
Counts by status.
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/order/ShipmentsCount' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example
{
    "data": {
        "totalShipment": 1336,
        "totalToBePickedUp": 76,
        "totalToBeDelivered": 18,
        "totalDelivered": 1232,
        "totalToBeReturned": 0,
        "totalReturned": 0,
        "totalCanceled": 8
    }
}
Previous
Rates
Next
All Shipments
Built with