Create Bulk Orders

Create Bulk Orders - Create one or more shipments

Use this endpoint to create one or more Flype shipments in a single request.

Each order in the request is processed individually. The response may include both accepted and denied orders.

Pickup and merchant identification

The pickup location and merchant may be different concepts, especially for aggregators and 3PLs.

externalLocationId identifies the physical pickup origin, such as a store, warehouse, fulfillment center, or 3PL facility.
merchantName identifies the customer-facing merchant or brand associated with the shipment.

Because multiple merchants may share the same pickup location, merchantName is required when using externalLocationId or pickupLocation, unless Flype has configured a unique merchant mapping for the authenticated account.

Pickup location options

externalLocationId - recommended for production

Use a saved pickup location identifier shared between your system and Flype.
postalCode only - limited fallback

Use only when Flype has pre-configured a single pickup location for the provided postal code.
full pickupLocation object - fallback

Provide the full pickup address when a saved pickup location is not available.

Important notes

This endpoint creates shipments.
Each order should include a unique shipperRef.
Use the returned trackingNumber as the primary Flype shipment reference.
Customer-facing merchant names may be shown in tracking and text message updates.

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

External Location RequestPickup location - zip codePickup location - full object

{
    "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": 40.7659247,
                    "longitude": -73.9848945
                }
            },
            "items": [
                {
                    "itemName": "Product Name",
                    "weight": 1500,
                    "quantity": 2
                }
            ],
            "pickupLocation": {
                "externalLocationId": "LOC123456"
            },
            "totalOrderWeight": 3000,
            "merchantName": "Store Name"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Bulk order result (accepted/denied).

Bodyapplication/json

Examples

Successfull ordersDenied order response

{
    "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"
            }
        ]
    }
}

🟠400

🟠401