Cancel a delivery

POST/v1/jobs/{id}/cancel

Cancellation depends on the current job status. Limits: 10 cancellation requests per store per minute.

Shell

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

Parameters

Name	Location	Type
`id`required	path	`string` uuid

Responses

Cancelled delivery

Field Type & constraints

datarequired

object

Show schema

Field Type & constraints

idrequired

string

uuid

externalOrderIdrequired

string

nullable

agentIdrequired

string

nullable

dropNamerequired string

dropAddressrequired string

dropCityrequired

string

nullable

dropPincoderequired

string

nullable

dropPhonerequired string

packageDescriptionrequired

string

nullable

chargeMinorrequired

integer

minimum 0 · maximum 9007199254740991 · nullable

settlementrequired

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

nullable

createdAtrequired

string

date-time

updatedAtrequired

string

date-time

pickupNamerequired

string

nullable

pickupAddressrequired string

pickupCityrequired

string

nullable

pickupPincoderequired

string

nullable

pickupPhonerequired

string

nullable

pickupLatituderequired

number

minimum -90 · maximum 90 · nullable

pickupLongituderequired

number

minimum -180 · maximum 180 · nullable

dropLatituderequired

number

minimum -90 · maximum 90 · nullable

dropLongituderequired

number

minimum -180 · maximum 180 · nullable

packageWeightrequired

string

nullable

packageWeightGramsrequired

integer

nullable

packageValuerequired

number

nullable

packageValueMinorrequired

integer

minimum 0 · maximum 9007199254740991 · nullable

riderLocationrequired

object

nullable

Show schema

Field	Type & constraints
`latitude`required	`number` minimum -90 · maximum 90
`longitude`required	`number` minimum -180 · maximum 180
`accuracy`required	`number` minimum 0 · nullable
`recordedAt`required	`string` date-time

eventsrequired

array

Show schema

Field	Type & constraints
`id`	`string` uuid
`status`	`"created" \| "queued" \| "picked_by_agent" \| "booking_in_progress" \| "booked" \| "pickup_completed" \| "delivered" \| "failed" \| "cancelled"`
`actor`	`string` nullable
`note`	`string` nullable
`createdAt`	`string` date-time

verificationrequired

object

Show schema

Field Type & constraints

testModerequired boolean

pickuprequired

object

Show schema

Field	Type & constraints
`status`required	`"pending" \| "active" \| "expired" \| "verified" \| "locked" \| "unavailable"`
`code`required	`string` nullable
`expiresAt`required	`string` date-time · nullable
`verifiedAt`required	`string` date-time · nullable

deliveryrequired

object

Show schema

Field	Type & constraints
`status`required	`"pending" \| "active" \| "expired" \| "verified" \| "locked" \| "unavailable"`
`code`required	`string` nullable
`expiresAt`required	`string` date-time · nullable
`verifiedAt`required	`string` date-time · nullable