LogisKitDocs
API v1

Getting started / Quickstart

Book your first delivery

Start with your store's API key and an API base URL. The examples below run on your backend.

Set LOGISKIT_API_URL without a trailing slash and LOGISKIT_API_KEY as shown in Authentication.

1

Check your credit

Read availableMinor to check the credit available for new bookings.

Shell
curl "$LOGISKIT_API_URL/v1/balance" \
  -H "X-Api-Key: $LOGISKIT_API_KEY"
2

Request a quote

Send both addresses and coordinates. Both stops must be in the same supported Nearby zone. The quote expires after five minutes.

Shell
curl -X POST "$LOGISKIT_API_URL/v1/job-quotes" \
  -H "X-Api-Key: $LOGISKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "pickupAddress": "10 Temple Road",
  "pickupCity": "Tirupati",
  "pickupPincode": "517501",
  "pickupLatitude": 13.6288,
  "pickupLongitude": 79.4192,
  "dropAddress": "24 Railway Station Road",
  "dropCity": "Tirupati",
  "dropPincode": "517501",
  "dropLatitude": 13.622,
  "dropLongitude": 79.425,
  "packageDescription": "Two meals",
  "packageWeightGrams": 1000,
  "packageValueMinor": 45000
}'
3

Book the delivery

Replace quoteId with the quote's data.id, enter your contacts, and choose an Idempotency-Key for this booking.

Shell
curl -X POST "$LOGISKIT_API_URL/v1/jobs" \
  -H "X-Api-Key: $LOGISKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1001" \
  -d '{
  "quoteId": "b563f6b5-413a-4a2d-9425-66f66d16bb9d",
  "externalOrderId": "order-1001",
  "pickupName": "Restaurant",
  "pickupPhone": "+919876543210",
  "dropName": "Customer",
  "dropPhone": "+919876543211"
}'
4

Follow the delivery

Replace {id} with the booked job's data.id. Poll for status changes, handoff verification, and the rider's location during an active assignment.

Shell
curl "$LOGISKIT_API_URL/v1/jobs/{id}" \
  -H "X-Api-Key: $LOGISKIT_API_KEY"