Shiplee
API Reference

$body    = @{ username = "you@example.com"; apikey = "your-api-key" } | ConvertTo-Json
$headers = @{ "Content-Type" = "application/json"; "Origin" = "http://localhost" }
Invoke-RestMethod -Uri "https://apiv1.shiplee.app/login" -Method Post -Body $body -Headers $headers

<?php
$ch = curl_init('https://apiv1.shiplee.app/login');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json','Origin: http://localhost'],
    CURLOPT_POSTFIELDS => json_encode(['username'=>'you@example.com','apikey'=>'your-api-key']),
]);
echo curl_exec($ch); curl_close($ch);

import requests
r = requests.post('https://apiv1.shiplee.app/login',
    json={'username': 'you@example.com', 'apikey': 'your-api-key'},
    headers={'Origin': 'http://localhost'})
token = r.json()['token']

const { token } = await fetch('https://apiv1.shiplee.app/login', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ username: 'you@example.com', apikey: 'your-api-key' })
}).then(r => r.json());

<?php
// Cancel single AWB — reset to new so you can re-book
$ch = curl_init('https://apiv1.shiplee.app/cancel_shipment');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'Authorization: Bearer YOUR_JWT_TOKEN',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'awb'    => 'XB1234567890',
        'action' => 'cancel',   // resets to 'new' — re-bookable
    ]),
]);
$res = json_decode(curl_exec($ch), true);
curl_close($ch);

if ($res['success']) {
    echo "Cancelled. Refunded: " . $res['refunded_count'] . " shipment(s).";
    // Order is now 'new' — call /rates then /create_shipment to re-book
} else {
    echo "Error: " . $res['message'];
}

import requests

headers = {'Authorization': 'Bearer YOUR_JWT_TOKEN'}

# Cancel single — re-bookable
r = requests.post('https://apiv1.shiplee.app/cancel_shipment',
    json={'awb': 'XB1234567890', 'action': 'cancel'},
    headers=headers)
print(r.json())
# {'success': True, 'message': 'Shipment(s) cancelled and reset to new...', 'refunded_count': 1}

# Cancel bulk — permanently deleted
r2 = requests.post('https://apiv1.shiplee.app/cancel_shipment',
    json={'awbs': ['XB1234567890', '37574910074362'], 'action': 'delete'},
    headers=headers)
print(r2.json())

// Cancel and re-book flow
async function cancelAndRebook(awb, orderId, warehouseId) {
    // Step 1 — cancel
    const cancel = await fetch('https://apiv1.shiplee.app/cancel_shipment', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer YOUR_JWT_TOKEN' },
        body: JSON.stringify({ awb, action: 'cancel' }),
    }).then(r => r.json());

    if (!cancel.success) throw new Error(cancel.message);

    // Step 2 — get new rates
    const rates = await fetch('https://apiv1.shiplee.app/rates', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer YOUR_JWT_TOKEN' },
        body: JSON.stringify({ orderId, warehouseId, shipmentType: 'forward' }),
    }).then(r => r.json());

    const carrier = rates.data.carrier_info[0]; // pick cheapest

    // Step 3 — re-book with new carrier
    const booking = await fetch('https://apiv1.shiplee.app/create_shipment', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer YOUR_JWT_TOKEN' },
        body: JSON.stringify({
            orderId, warehouseId, action: 'book_shipment',
            carrierId: carrier.carrier_id, carrierName: carrier.carrier_name,
            shipmentType: 'forward',
        }),
    }).then(r => r.json());

    return booking; // { success: true, awb_number: 'NEW_AWB', ... }
}

{
    "event": "picked_up", "awb": "77753820620", "order_id": "JBYNK74840",
    "status": "IT", "message": "Shipment picked up",
    "location": "KATARGAM HUB", "timestamp": "2026-04-09 19:58:00",
    "courier": "Bluedart- Surface", "payment": "cod", "order_value": 499,
    "customer": { "name": "Nikhil Maurya", "mobile": "6393538851",
        "city": "BENGALURU URBAN", "state": "KARNATAKA", "pincode": "560098" }
}

{
    "event": "out_for_delivery", "awb": "14345140408980", "order_id": "ORD-654321",
    "status": "OFD", "message": "Out for delivery",
    "location": "ANDHERI WEST HUB", "timestamp": "2026-04-10 09:22:00",
    "courier": "Delhivery Express", "payment": "prepaid", "order_value": 1299,
    "customer": { "name": "Priya Sharma", "mobile": "9876543210",
        "city": "Mumbai", "state": "Maharashtra", "pincode": "400053" }
}

{
    "event": "failed_delivery", "awb": "37574910074362", "order_id": "ORD-999",
    "status": "NDR", "message": "Delivery attempted - customer not available",
    "location": "DELHI EAST HUB", "timestamp": "2026-04-10 14:30:00",
    "courier": "XpressBees", "payment": "cod", "order_value": 850,
    "awb_status_id": "4821",
    "customer": { "name": "Rahul Verma", "mobile": "9123456789",
        "city": "Delhi", "state": "Delhi", "pincode": "110092" }
}

{
    "event": "delivered", "awb": "80905112190", "order_id": "ORD-112233",
    "status": "DL", "message": "Shipment delivered",
    "location": "WHITEFIELD OFFICE", "timestamp": "2026-04-10 17:45:00",
    "courier": "Blue Dart- Apex", "payment": "cod", "order_value": 1450,
    "customer": { "name": "Amit Singh", "mobile": "9900000001",
        "city": "Bangalore", "state": "Karnataka", "pincode": "560066" }
}

{
    "event": "rto", "awb": "77838902293", "order_id": "ORD-445566",
    "status": "RTO", "message": "Return to origin initiated",
    "location": "MUMBAI SORT CENTER", "timestamp": "2026-04-10 11:10:00",
    "courier": "Delhivery Surface", "payment": "prepaid", "order_value": 599,
    "customer": { "name": "Kavya Reddy", "mobile": "9988776655",
        "city": "Hyderabad", "state": "Telangana", "pincode": "500034" }
}

from flask import Flask, request, jsonify, abort

app = Flask(__name__)
SECRET = 'your-secret-api-key'

@app.route('/webhook/shiplee', methods=['POST'])
def shiplee_webhook():
    # Verify auth header
    if request.headers.get('x-api-key') != SECRET:
        abort(401)

    payload = request.json
    event   = payload.get('event')
    awb     = payload.get('awb')

    handlers = {
        'booked':           handle_booked,
        'picked_up':        handle_picked_up,
        'out_for_delivery': handle_ofd,
        'failed_delivery':  handle_ndr,
        'delivered':        handle_delivered,
        'rto':              handle_rto,
    }
    if event in handlers:
        handlers[event](payload)

    # Must return 200
    return jsonify({'received': True}), 200

const express = require('express');
const app = express();
app.use(express.json());

const SECRET = 'your-secret-api-key';

app.post('/webhook/shiplee', (req, res) => {
    // Verify auth header
    if (req.headers['x-api-key'] !== SECRET) {
        return res.status(401).json({ error: 'Unauthorized' });
    }

    const { event, awb, order_id, customer } = req.body;

    const handlers = {
        booked:           () => console.log(`Booked: ${awb}`),
        picked_up:        () => console.log(`Picked up: ${awb}`),
        out_for_delivery: () => console.log(`OFD: ${awb}`),
        failed_delivery:  () => console.log(`NDR: ${awb}`),
        delivered:        () => console.log(`Delivered: ${awb} to ${customer.name}`),
        rto:              () => console.log(`RTO: ${awb}`),
    };

    handlers[event]?.();

    // Must return 200
    res.json({ received: true });
});

app.listen(3000);

<?php
$ch = curl_init('https://apiv1.shiplee.app/label');
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER=>true,CURLOPT_POST=>true,
    CURLOPT_HTTPHEADER=>['Content-Type: application/json','Authorization: Bearer YOUR_JWT_TOKEN'],
    CURLOPT_POSTFIELDS=>json_encode(['awb'=>'80905112190'])]);
$res = curl_exec($ch);
$ct  = curl_getinfo($ch, CURLINFO_CONTENT_TYPE); curl_close($ch);
if (str_contains($ct,'application/pdf')) { file_put_contents('label.pdf',$res); echo "Saved."; }
else { echo json_decode($res,true)['message']; }

import requests
r = requests.post('https://apiv1.shiplee.app/label',
    json={'awb': '80905112190'},
    headers={'Authorization': 'Bearer YOUR_JWT_TOKEN'})
if r.headers.get('Content-Type','').startswith('application/pdf'):
    open('label.pdf','wb').write(r.content)
else: print(r.json()['message'])

const res = await fetch('https://apiv1.shiplee.app/label', {
    method:'POST', headers:{'Content-Type':'application/json','Authorization':'Bearer YOUR_JWT_TOKEN'},
    body: JSON.stringify({ awb: '80905112190' })
});
if (res.headers.get('Content-Type')?.includes('application/pdf')) {
    const a = Object.assign(document.createElement('a'),
        {href: URL.createObjectURL(await res.blob()), download:'label.pdf'});
    a.click();
}