LogisKitDocs
API v1

Get delivery details

GET/v1/jobs/{id}

Includes status history and handoff verification. Rider location is available only during an active assignment. Verification codes can be null depending on their state and visibility. Shares the read limit of 60 requests per store per minute.

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

Parameters

NameLocationType
idrequiredpathstring

uuid

Responses

Delivery details

FieldType & constraints
datarequiredobject
Show schema
FieldType & constraints
idrequiredstring

uuid

externalOrderIdrequiredstring

nullable

statusrequired"created" | "queued" | "picked_by_agent" | "booking_in_progress" | "booked" | "pickup_completed" | "delivered" | "failed" | "cancelled"
agentIdrequiredstring

nullable

dropNamerequiredstring
dropAddressrequiredstring
dropCityrequiredstring

nullable

dropPincoderequiredstring

nullable

dropPhonerequiredstring
packageDescriptionrequiredstring

nullable

chargeMinorrequiredinteger

minimum 0 · maximum 9007199254740991 · nullable

settlementrequired"reserved" | "review" | "captured" | "released"

nullable

createdAtrequiredstring

date-time

updatedAtrequiredstring

date-time

pickupNamerequiredstring

nullable

pickupAddressrequiredstring
pickupCityrequiredstring

nullable

pickupPincoderequiredstring

nullable

pickupPhonerequiredstring

nullable

pickupLatituderequirednumber

minimum -90 · maximum 90 · nullable

pickupLongituderequirednumber

minimum -180 · maximum 180 · nullable

dropLatituderequirednumber

minimum -90 · maximum 90 · nullable

dropLongituderequirednumber

minimum -180 · maximum 180 · nullable

packageWeightrequiredstring

nullable

packageWeightGramsrequiredinteger

nullable

packageValuerequirednumber

nullable

packageValueMinorrequiredinteger

minimum 0 · maximum 9007199254740991 · nullable

riderLocationrequiredobject

nullable

Show schema
FieldType & constraints
latituderequirednumber

minimum -90 · maximum 90

longituderequirednumber

minimum -180 · maximum 180

accuracyrequirednumber

minimum 0 · nullable

recordedAtrequiredstring

date-time

eventsrequiredarray
Show schema
FieldType & constraints
idstring

uuid

status"created" | "queued" | "picked_by_agent" | "booking_in_progress" | "booked" | "pickup_completed" | "delivered" | "failed" | "cancelled"
actorstring

nullable

notestring

nullable

createdAtstring

date-time

verificationrequiredobject
Show schema
FieldType & constraints
testModerequiredboolean
pickuprequiredobject
Show schema
FieldType & constraints
statusrequired"pending" | "active" | "expired" | "verified" | "locked" | "unavailable"
coderequiredstring

nullable

expiresAtrequiredstring

date-time · nullable

verifiedAtrequiredstring

date-time · nullable

deliveryrequiredobject
Show schema
FieldType & constraints
statusrequired"pending" | "active" | "expired" | "verified" | "locked" | "unavailable"
coderequiredstring

nullable

expiresAtrequiredstring

date-time · nullable

verifiedAtrequiredstring

date-time · nullable