> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apps.lute.co.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start shipping programmatically in 5 minutes with the Shipdesk Public REST API.

# Quickstart Guide

This walkthrough guides you through obtaining an API key, checking courier serviceability, creating an order, assigning a carrier, and downloading an official shipping label PDF.

## 1. Obtain your API Key

1. Sign in to your Shipdesk dashboard at [apps.lute.co.in](https://apps.lute.co.in).
2. Navigate to **Settings** (`⚙`) → **API & Webhooks**.
3. Under **API Keys**, click **+ Generate API key**.
4. Select **Production (sd\_live\_)** or **Sandbox (sd\_test\_)** and copy your secret token.

```bash theme={null}
export SHIPDESK_API_KEY="sd_live_your_secret_key"
export API_BASE="https://api.apps.lute.co.in/v1"
```

***

## 2. Check Courier Rates & Serviceability

Before booking, verify that your parcel's destination PIN code is served for your payment method (Prepaid or COD):

```bash theme={null}
curl -X POST "$API_BASE/rates" \
  -H "Authorization: Bearer $SHIPDESK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pickup_pin": "110001",
    "delivery_pin": "560038",
    "weight": 0.5,
    "pay": "Prepaid",
    "amount": 1499
  }'
```

### Standard Response

```json theme={null}
{
  "success": true,
  "data": [
    {
      "carrier": "Delhivery",
      "mode": "Surface",
      "price": 42.01,
      "days": 4,
      "cod_available": true
    },
    {
      "carrier": "Delhivery",
      "mode": "Express",
      "price": 90.0,
      "days": 2,
      "cod_available": true
    },
    {
      "carrier": "Ekart",
      "mode": "Express",
      "price": 78.5,
      "days": 2,
      "cod_available": true
    }
  ],
  "meta": {
    "timestamp": "2026-11-22T16:20:00.000Z",
    "request_id": "req_83918239"
  }
}
```

***

## 3. Create an Order

Create a forward order ready for fulfillment:

```bash theme={null}
curl -X POST "$API_BASE/orders" \
  -H "Authorization: Bearer $SHIPDESK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "ORD-5012",
    "channel": "API",
    "type": "Forward",
    "customer": "Rohan Deshmukh",
    "phone": "9820123456",
    "address": "402 Palm Heights, Linking Road, Bandra West",
    "city": "Mumbai",
    "state": "Maharashtra",
    "pin": "400050",
    "item": "Mechanical Gaming Keyboard",
    "qty": 1,
    "weight": 0.85,
    "pay": "Prepaid",
    "amount": 3499
  }'
```

***

## 4. Assign Courier & Generate AWB

Assign the courier of your choice. Shipdesk calls the carrier API in real time and issues the tracking AWB:

```bash theme={null}
curl -X POST "$API_BASE/orders/ORD-5012/assign" \
  -H "Authorization: Bearer $SHIPDESK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "courier": "Delhivery - Express"
  }'
```

### Standard Response

```json theme={null}
{
  "success": true,
  "data": {
    "awb": "129038102931",
    "carrier": "Delhivery",
    "mode": "Express",
    "status": "Ready to ship",
    "edd": "2026-11-25"
  },
  "meta": {
    "timestamp": "2026-11-22T16:20:05.000Z",
    "request_id": "req_99823120"
  }
}
```

***

## 5. Download Shipping Label PDF

Download the barcode shipping label directly from Shipdesk:

```bash theme={null}
curl -X GET "$API_BASE/orders/ORD-5012/label" \
  -H "Authorization: Bearer $SHIPDESK_API_KEY" \
  --output label-ORD-5012.pdf
```

The PDF contains the standard courier Code 128 barcode, recipient address, item SKU, and routing codes ready for thermal printing (4 x 6 inch).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.