Flype Order API
  1. Shipments
  • Flype Order API
    • Shipments
      • Rates
        POST
      • Create Bulk Orders
        POST
      • All Shipments
        POST
      • Shipments Count
        GET
      • Shipment Details
        GET
      • Shipment Last Status
        GET
      • Cancel Shipment
        GET
      • 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

Check service availability & ETA#

Returns the available delivery service options for the given order details (Same-Day / Next-Day) and the expected pickup time and delivery date.

Pickup identification (required)#

Provide one of the following:
externalLocationId (recommended), OR
postalCode
At least one of externalLocationId or postalCode must be included in the request.
How to interpret the response
serviceOptions contains one or more available services.
If serviceOptions is empty, the service is not available and a reason object is returned (e.g., OUT_OF_ZONE).
pickupToday is true when the order is before the cutoff hour (pickup happens today), otherwise false (pickup happens next day).
All timestamps are 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

Responses

🟢200
application/json
Bodyapplication/json

🟠401
🟠400
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
        }
    ]
}'
Response Response Example
200 - Same day service available
Valid if request was sent before same day cut off hour.
{
  "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"
      }
    }
  ]
}
Next
Create Bulk Orders
Built with