Bulk Order

PlaceBulk - Create bulk shipments

Create multiple shipments in a single request.

Pickup location options

To generate a shipping label, send an SMS/message to the recipient, and include the shipment in route planning, pickup information must be provided.

You can provide pickup information in one of the following ways:

Option 1: Use `externalLocationId` — recommended

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

This option is usually best for 3PLs or merchants with fixed pickup locations that do not change often. It provides the most accurate and fastest store matching.

Required fields for this option:

externalLocationId

serviceType

merchantName

Option 2: Use `pickupLocation`

Use this option when you do not have an externalLocationId.

This requires the full pickup address details.

Required fields for this option:

pickupLocation

serviceType

merchantName

Important notes

merchantName is required when either pickupLocation or externalLocationId is provided.

It is used to filter stores by retailer name and ensure that the correct store is matched. Without merchantName, the system cannot accurately identify which retailer store should be used for pickup.

If an order is sent without externalLocationId or pickupLocation, and without serviceType:

The order will not be considered for route planning until pickup is scheduled.

No text message will be sent to the recipient until pickup is scheduled.

No shipping label will be created or returned, because labels require store or pickup location information.

Pickup scheduling

You must schedule the pickup in one of two ways:

In the PlaceBulk request by including either externalLocationId or pickupLocation, together with serviceType and merchantName.

After the order is created, by using endpoint #4: SchedulePickup.

If pickup is scheduled later using SchedulePickup, the shipping label will be created and returned only when pickup is scheduled.

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 RequestUsing pickupLocationCOD order - with pickup location

{
    "list": [
        {
            "totalCOG": 120.25,
            "shipperRef": "0123456",
            "remarks": "Leave with doorman",
            "recipient": {
                "name": "John Doe",
                "phoneNumber": "13026021805",
                "email": "john@gmail.com",
                "address": {
                    "street1": "34 Marasi Dr",
                    "street2": "APT 28C",
                    "city": "Dubai",
                    "country": "United Arab Emirates",
                    "latitude": 25.179812819235188,
                    "longitude": 55.265600039741905
                }
            },
            "items": [
                {
                    "itemName": "Product Name",
                    "weight": 150,
                    "quantity": 2
                }
            ],
            "externalLocationId": "LOC123456",
            "serviceType": "SAME_DAY",
            "totalOrderWeight": 3000,
            "merchantName": "Store Name"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Successful response

Body

Examples

SuccessExample Response with no labels generatedDeined order example response

{
    "acceptedOrders": [
        {
            "status": "success",
            "shipperRef": "0123456",
            "trackingNumber": "DEL-123456",
            "label": "https://storage.googleapis.com/bucket/label/abc123/shippingLabel",
            "pickupTime": "2024-01-15T12:00:00.000Z",
            "serviceType": "SAME_DAY",
            "externalLocationId": "LOC123456"
        }
    ],
    "deniedOrders": []
}

🟠401

PlaceBulk - Create bulk shipments#

Pickup location options#

Option 1: Use externalLocationId — recommended#

Option 2: Use pickupLocation#

Important notes#

Pickup scheduling#