Flype Order API
  1. Webhook
  • Flype Order API
    • Introduction
    • Shipments
      • Rates
      • Create Bulk Orders
      • All Shipments
      • Shipments Count
      • Shipment Details
      • Shipment Last Status
      • Cancel Shipment
      • Get Shipping Label
    • Webhook
      • Webhook: Shipment status updates (Flype → Your Server)
        POST
    • Locations
      • Upsert Pickup Location
      • Get Saved Pickup Locations
      • Fetch Pickup Location Details
    • 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. Webhook

Webhook: Shipment status updates (Flype → Your Server)

POST
/flype/webhook/shipment-status

Webhook - Shipment status updates from Flype to your server#

Flype can send shipment status updates to a webhook endpoint provided by the partner.
This is not an endpoint that the partner calls. Instead, the partner provides Flype with a webhook URL, and Flype sends a request to that URL when a shipment status changes.

Partner requirements#

  • Provide a publicly reachable HTTPS webhook URL.
  • Accept POST requests with a JSON body.
  • Return a successful 2xx response when the webhook is received.
  • Handle duplicate webhook events safely.

Authentication#

If webhook authentication is required, provide Flype with the required authentication method and credentials. For example, Flype can include a bearer token or custom header when sending webhook requests.

Important notes#

  • Webhook events should be treated as status notifications.
  • Partners should use trackingNumber to match webhook updates to shipments in their system.
  • If a webhook delivery fails, Flype may retry depending on the agreed integration setup.

Request

Body Params application/jsonRequired

Example
{
    "trackingNumber": "F78ECYH0BNZ8",
    "status": "delivered",
    "orderDate": "2025-10-30T15:12:34.000Z"
}

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 '/flype/webhook/shipment-status' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "trackingNumber": "F78ECYH0BNZ8",
    "status": "delivered",
    "orderDate": "2025-10-30T15:12:34.000Z"
}'

Responses

🟢200
application/json
Acknowledgement
Bodyapplication/json

Example
{
    "status": "success"
}
Previous
Get Shipping Label
Next
Upsert Pickup Location
Built with