shippingservice/documentation/ekart

Ekart Logistics API Documentation

This directory contains comprehensive integration documentation for the Ekart Logistics API (v3.8.10), extracted from https://app.elite.ekartlogistics.in/api/docs.

---

Overview & Base URL

• Base URL: https://app.elite.ekartlogistics.in
• Specification Format: OpenAPI 3.1.0
• Content Type: application/json (except label download which returns binary PDF / stream)

---

Authentication Mechanism

All protected API calls require a Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Fetching Access Token

• Endpoint: POST /integrations/v2/auth/token/{client_id}
• Security: Open (No token needed for this endpoint)
• Token Validity: Standard token valid for 24 hours (expires_in seconds returned in response). Cached API returning the same token within 24h window.

---

Key Modules / Tag Groups

1. Authorization

   • Fetch Bearer access token using client_id, username, and password.

2. V1 API

   • Shipments: Create Forward/Reverse/MPS/OBD/QC shipments, cancel shipments, update preferred dispatch dates, update EWBN.
   • Track: Open tracking API /api/v1/track/{id} & Ekart Raw Tracking API /data/v1/elite/track/{wbn}.
   • Label: Download shipment PDF packing slips/labels.
   • Estimate V1: Get estimated shipping rates for sample shipment requests.

3. V2 API

   • Manifest V2: Generate & download pickup manifests.
   • Address V2: Add & retrieve registered seller pickup / RTO warehouse addresses.
   • NDR V2: Take Non-Delivery Report (NDR) actions (Re-Attempt, RTO).
   • Serviceability V2: Check pincode COD and forward/reverse serviceability.
   • Webhook V2: Add, update, and get active webhooks (track_updated, shipment_created, shipment_recreated).

4. V3 API

   • Serviceability V3: Courier partner selection & rate/TAT estimates for pickup & drop pincode pairs; Bulk serviceability download.

---

File Structure

• README.md - Summary & index of Ekart API documentation.
• api_spec.md - Detailed API specification with endpoints, request/response schemas, payload examples, and status code references.