Check coverage

POST

/api/order/CheckCoverage

Tells you whether MyCourier can deliver to a destination, with which service and on which dates. Use it before placing an order, or to offer your customer a delivery date.

Send the destination postal code; it is required. Latitude and longitude are optional and help where a delivery area is drawn on the map. externalLocationId is the code of the pickup location; leave it out to check every active pickup location of your account. When the destination can be served, the reply's externalLocationId is the pickup location that serves it.

A destination that cannot be served is still a 200 reply with serviceable: false and a reasonCode.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "serviceType": "NEXT_DAY",
    "externalLocationId": "ITPU1",
    "destination": {
        "postalCode": "M5V 3L9"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://flype-ops-panel-dev.web.app/api/order/CheckCoverage' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "serviceType": "NEXT_DAY",
    "externalLocationId": "ITPU1",
    "destination": {
        "postalCode": "M5V 3L9"
    }
}'

Responses

🟢200

application/json

The coverage answer.

Bodyapplication/json

Examples

ServiceableNot serviceable

{
    "status": "success",
    "serviceable": true,
    "requestedServiceType": "NEXT_DAY",
    "effectiveServiceType": "NEXT_DAY",
    "pickupDate": "2026-10-27",
    "expectedDeliveryDate": "2026-10-28",
    "externalLocationId": "ITPU1",
    "reasonCode": "SERVICEABLE",
    "message": "Next-day is available.",
    "options": [
        {
            "serviceType": "SAME_DAY",
            "pickupDate": "2026-10-27",
            "expectedDeliveryDate": "2026-10-27"
        },
        {
            "serviceType": "NEXT_DAY",
            "pickupDate": "2026-10-27",
            "expectedDeliveryDate": "2026-10-28"
        }
    ]
}

🟠400

🟠401

🟠403

Modified at 2026-11-03 13:10:33

Introduction

Place orders