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

Service Coverage

POST
/api/order/CheckCoverage

CheckCoverage - Check delivery coverage and availability#

Use this endpoint to check whether a destination address is serviceable before creating an order.
The API checks whether Flype can deliver to the provided destination based on the requested serviceType, destination city, and coordinates. It also evaluates cutoff time and operational calendar rules to determine the expected delivery date and effective service type.
If valid latitude and longitude are provided, the API will use them directly for the coverage check. If coordinates are not provided or are not usable, the API will attempt to geocode the provided address details.

When to use this endpoint#

  • Before creating an order with PlaceBulk.
  • During checkout or order validation to confirm whether the delivery destination is covered.
  • To determine the expected delivery date before submitting the order.
  • To avoid submitting orders that are outside the supported delivery coverage area.

Coordinates behavior#

  • If valid latitude and longitude are provided, they will be used for the coverage check.
  • Coordinates must be valid non-zero numbers.
  • If coordinates are missing, invalid, or set to 0, the API will attempt to geocode the provided address.
  • If the address cannot be geocoded, the response will indicate that the address location could not be verified.

Service availability behavior#

  • The endpoint evaluates the requested service against Flype’s cutoff time and operating days.
  • If the destination is serviceable but the cutoff has passed, the response may return a later expectedDeliveryDate.
  • If the next available delivery day falls on a non-operating day, the response will move the delivery date to the next valid operating day.
  • effectiveServiceType indicates the service timing that will actually apply after cutoff and operating-day rules are evaluated.

Important notes#

  • This endpoint does not create an order.
  • This endpoint checks whether the destination is serviceable and what delivery timing would apply if the order is created.
  • A serviceable response means the destination is within the supported delivery coverage area for the requested service type.
  • If serviceable is null, the API could not make a coverage decision, usually because the address could not be verified or an internal error occurred.
  • expectedDeliveryDate is returned as a local delivery date in YYYY-MM-DD format.

Summary#

Use CheckCoverage to confirm delivery coverage and expected delivery timing before creating an order. Provide destination coordinates when available for the most accurate result.

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
{
    "serviceType": "SAME_DAY",
    "destination": {
        "streetAddress1": "34 Marasi Drive",
        "streetAddress2": "APT 511",
        "latitude": 25.179812819235188,
        "longitude": 55.265600039741905,
        "city": "Dubai",
        "country": "United Arab Emirates"
    }
}

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
curl --location '/api/order/CheckCoverage' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "serviceType": "SAME_DAY",
    "destination": {
        "streetAddress1": "34 Marasi Drive",
        "streetAddress2": "APT 511",
        "latitude": 25.179812819235188,
        "longitude": 55.265600039741905,
        "city": "Dubai",
        "country": "United Arab Emirates"
    }
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Examples
{
  "status": "success",
  "serviceable": true,
  "requestedServiceType": "SAME_DAY",
  "effectiveServiceType": "SAME_DAY",
  "expectedDeliveryDate": "2026-05-18",
  "reasonCode": "SERVICEABLE",
  "message": "Zone is serviceable for SAME_DAY."
}
🟠401Unauthorized
🟠400Invalid Request
🟠400Service Not Available
🔴500Internal Error
Previous
Introduction
Next
Shipments Count
Built with