Create Bulk Orders

POST

/order/placeBulk

PlaceBulk - Create bulk shipments

Create multiple shipments in a single request.

Pickup location options (choose ONE)

You can identify the pickup location in one of these ways:

externalLocationId (recommended)

Use a unique pickup location ID shared between you and Flype.

Best accuracy and fastest matching.

See External location request.

postal code only (recommended)

Provide only postalCode to let Flype determine the pickup location.

See pickup location - zip code.

full pickup address (fallback)

Provide full pickupLocation object (street, city, country, etc.).

Use this when you don’t have externalLocationId.

See pickup location - full object.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bulk order result (accepted/denied).

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

cURL

External Location RequestPickup location - zip codePickup location - full object

curl --location '/order/placeBulk' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "list": [
        {
            "totalCOG": 120.25,
            "shipperRef": "0123456",
            "remarks": "Leave with doorman",
            "recipient": {
                "name": "John Doe",
                "phoneNumber": "13026021805",
                "email": "john@gmail.com",
                "address": {
                    "street1": "235 West 56th street",
                    "street2": "APT 28C",
                    "streetNumber": "235",
                    "postalCode": "10019",
                    "city": "New York",
                    "country": "United States",
                    "latitude": 25.179812819235188,
                    "longitude": 55.265600039741905
                }
            },
            "items": [
                {
                    "itemName": "Product Name",
                    "weight": 1.5,
                    "quantity": 2
                }
            ],
            "pickupLocation": {
                "externalLocationId": "LOC123456"
            },
            "totalOrderWeight": 3000,
            "merchantName": "Store Name"
        }
    ]
}'

Response Example

200 - Successfull orders

{
    "status": "success",
    "data": {
        "acceptedOrders": [
            {
                "status": "SUCCESS",
                "shipperRef": "0123456",
                "trackingNumber": "UH44RJUVSC0X",
                "estimatedDeliveryWindowUtc": {
                    "start": "2026-02-15T18:00:00Z",
                    "end": "2026-02-15T22:00:00Z"
                },
                "externalLocationId": "LOC123456",
                "label": "https://storage.googleapis.com/flype-a8461.appspot.com/label/11F0048348C1EED6A79F41010A800004/shippingLabel",
                "pickupDateUtc": "2026-02-15T13:00:00Z"
            },
            {
                "status": "SUCCESS",
                "shipperRef": "0123437",
                "trackingNumber": "TY08EJXVNCYO",
                "estimatedDeliveryWindowUtc": {
                    "start": "2026-02-15T18:00:00Z",
                    "end": "2026-02-15T22:00:00Z"
                },
                "externalLocationId": "LOC123456",
                "label": "https://storage.googleapis.com/flype-a8461.appspot.com/label/11F0028344C1EED6A77F51010A800004/shippingLabel",
                "pickupDateUtc": "2026-02-15T13:00:00Z"
            }
        ]
    }
}

Rates

All Shipments

Create Bulk Orders

PlaceBulk - Create bulk shipments#

Pickup location options (choose ONE)#

Request

Responses

PlaceBulk - Create bulk shipments

Pickup location options (choose ONE)