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

Rates

POST
/rates

Rates - Check service availability and estimated delivery timing#

Use this endpoint to check available Flype delivery service options before creating an order.
The API evaluates the pickup origin, destination address, package details, service coverage, cutoff time, and operating rules to return available service options.

When to use this endpoint#

  • Before creating an order with Create Bulk Orders.
  • During checkout or order validation to confirm whether Flype service is available.
  • To retrieve expected pickup timing and estimated delivery timing.

Pickup identification#

For production integrations, Flype recommends using externalLocationId to identify the pickup origin.
  1. externalLocationId - recommended

    Identifies a saved pickup location such as a store, warehouse, fulfillment center, or 3PL facility.
  2. postalCode only - limited fallback

    Can be used only when Flype has pre-configured a single pickup location for the provided postal code.
  3. full pickup details - fallback

    Use when no saved pickup location is available.

Important notes#

  • This endpoint does not create an order.
  • This endpoint does not reserve delivery capacity.
  • If no service option is available, the response will include a reason explaining why service is unavailable.
  • All exact timestamps are returned in UTC unless otherwise specified.

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
{
    "pickup": {
        "externalLocationId": "LOC123467"
    },
    "shipTo": {
        "street1": "235 West 56th street",
        "city": "New York",
        "country": "United States",
        "postalCode": "10019"
    },
    "packages": [
        {
            "weight": 1.5
        },
        {
            "weight": 2
        }
    ]
}

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 '/rates' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "pickup": {
        "externalLocationId": "LOC123467"
    },
    "shipTo": {
        "street1": "235 West 56th street",
        "city": "New York",
        "country": "United States",
        "postalCode": "10019"
    },
    "packages": [
        {
            "weight": 1.5
        },
        {
            "weight": 2
        }
    ]
}'

Responses

🟢200
application/json
Bodyapplication/json

Examples
Valid if request was sent before same day cut off hour.
{
  "status": "success",
  "serviceOptions": [
    {
      "serviceType": "SAME_DAY",
      "pickupToday": true,
      "pickupTimeUtc": "2026-02-15T20:00:00Z",
      "estimatedDeliveryWindowUtc": {
        "start": "2026-02-15T18:00:00Z",
        "end": "2026-02-15T22:00:00Z"
      },
      "price": {
        "currency": "USD",
        "charge": 0,
        "note": "Contract pricing"
      }
    }
  ]
}
🟠401
🟠400
Previous
Introduction
Next
Create Bulk Orders
Built with