Overview

Welcome to the Shiplee API, a robust platform for integrating logistics and order management. This API enables sellers to authenticate securely, create orders with flexible billing options, manage warehouses, and handle shipments efficiently.

Base URL: https://apiv1.shiplee.app

Key Features:

• JWT-based authentication with IP and domain whitelisting.
• Order creation supporting same or different billing and shipping addresses.
• Warehouse management for adding and retrieving pickup locations.
• Shipment booking with courier rate fetching and tracking.

Authentication

The Shiplee API uses JSON Web Tokens (JWT) for secure authentication. Follow these steps to access protected endpoints:

1. Obtain API Credentials: Register at app.shiplee.ai and generate an API key in the API Settings.
2. Whitelist IP and Domain: Add your server’s IP (e.g., 106.51.205.161) and domain (e.g., localhost) in the API Settings for security.
3. Authenticate: Send a POST request to /login with your credentials to receive a JWT token, which is valid for 1 hour.
4. Use JWT Token: Include the token in the Authorization: Bearer header for all subsequent requests to protected endpoints.

Login Endpoint

POST /login

Authenticates a user and returns a JWT token for accessing protected endpoints.

Request Body

{
    "username": "demo@shiplee.in",
    "apikey": "your-api-key"
}
                

Examples

• curl
• PowerShell
• PHP
• Python
• JavaScript

curl -X POST https://apiv1.shiplee.app/login \
-H "Content-Type: application/json" \
-H "Origin: http://localhost" \
-H "X-Forwarded-For: 106.51.205.161" \
-d '{"username": "demo@shiplee.in", "apikey": "your-api-key"}'
                        

$body = @{
    username = "demo@shiplee.in"
    apikey = "your-api-key"
} | ConvertTo-Json

$headers = @{
    "Content-Type"    = "application/json"
    "Origin"          = "http://localhost"
    "X-Forwarded-For" = "106.51.205.161"
}

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($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Origin: http://localhost',
    'X-Forwarded-For: 106.51.205.161'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'username' => 'demo@shiplee.in',
    'apikey' => 'your-api-key'
]));

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
                        

import requests
import json

url = 'https://apiv1.shiplee.app/login'
headers = {
    'Content-Type': 'application/json',
    'Origin': 'http://localhost',
    'X-Forwarded-For': '106.51.205.161'
}
data = {
    'username': 'demo@shiplee.in',
    'apikey': 'your-api-key'
}

response = requests.post(url, json=data, headers=headers)
print(json.dumps(response.json(), indent=4))
                        

const url = 'https://apiv1.shiplee.app/login';
const data = {
    username: 'demo@shiplee.in',
    apikey: 'your-api-key'
};

fetch(url, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log('Token:', data.token))
.catch(error => console.error('Error:', error));
                        

Success Response (200)

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {
        "id": 62,
        "email": "demo@shiplee.in",
        "shiplee_id": "d10701280b9798033c6917e9415b03c3"
    }
}
                

Add Order Endpoint

POST /order

Creates a new order with customer, billing, product, and parcel details. Supports both same and different billing/shipping addresses.

Request Body

{
    "pincode": "560098",
    "city": "Bangalore",
    "state": "Karnataka",
    "name": "John Doe",
    "email": "customer@example.com",
    "mobileNumber": "9000000001",
    "addressLine1": "123 Sample Street, Apt 4B",
    "sameAddressCheckbox": 1,
    "orderID": "ORD-123456",
    "paymentType": "prepaid",
    "products": [
        {
            "productName": "Sample Product",
            "quantity": 2,
            "productPrice": 50.00,
            "sku": "SKU123"
        }
    ],
    "parcels": [
        {
            "length": 10,
            "breadth": 10,
            "height": 10,
            "physicalWeight": 1.5
        }
    ]
}
                

Success Response (201)

{
    "success": true,
    "message": "Order added successfully",
    "order_id": 484900
}
                

Reverse Order Endpoint Coming Soon

This endpoint will allow you to programmatically create reverse pickup orders for returns or exchanges.

Create Shipment Endpoint

POST /create_shipment

Books a shipment for an existing order by assigning a courier. This action requires a valid orderId, warehouseId, and courier details obtained from the rates endpoint.

Request Body

{
    "orderId": 484900,
    "warehouseId": 2147483833,
    "action": "book_shipment",
    "carrierId": "12298",
    "carrierName": "Xpressbees 1 K.G",
    "shipmentType": "forward"
}
                

Success Response (201)

{
    "success": true,
    "message": "Shipment booked",
    "awb_number": "XB1234567890",
    "shipment_id": "SHPL-54321"
}
                

Reverse Shipment Endpoint Coming Soon

This endpoint will be used to book a reverse shipment for an existing reverse order, assigning a courier for the pickup.

Rates Endpoint

POST /rates

Fetches available courier rates for an existing order based on its weight, dimensions, and delivery location.

Request Body

{
    "orderId": 484900,
    "warehouseId": 2147483833,
    "shipmentType": "forward"
}
                

Success Response (200)

{
    "success": true,
    "message": "Rates fetched successfully",
    "data": {
        "carrier_info": [
            {
                "carrier_id": "12298",
                "carrier_name": "Xpressbees 1 K.G",
                "cost": 138,
                "freight_charges": 138,
                "cod_charges": 0
            },
            {
                "carrier_id": "279",
                "carrier_name": "Bluedart- Surface",
                "cost": 190,
                "freight_charges": 190,
                "cod_charges": 0
            }
        ]
    }
}
                

Warehouse Management

Manage your pickup locations for shipments. You can add new warehouses or retrieve a list of existing ones.

Add Warehouse

POST /add_warehouse

Adds a new warehouse, which serves as a pickup address for your shipments.

{
    "nickname": "Main Warehouse",
    "mobileNumber": "9000000001",
    "address1": "123 Logistics Road",
    "pincode": "123456",
    "state": "Sample State",
    "city": "Sample City",
    "addressType": "primary"
}
                

Get Warehouses

GET /get_warehouses

Retrieves a list of all non-deleted warehouses for the authenticated seller.

// Example Success Response (200)
{
    "success": true,
    "message": "Warehouses retrieved successfully",
    "data": [
        {
            "id": 2147483833,
            "nickname": "Main Warehouse",
            "address1": "123 Logistics Road",
            "pincode": "123456",
            "city": "Sample City",
            "state": "Sample State",
            "addressType": "primary"
        }
    ]
}
                

Support

For technical assistance or questions about the API, please contact our support team:

• Email: support@shiplee.app
• WhatsApp: +91 8645322815