Skip to main content
POST
Have the sandbox driver report a delivery as failed

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Path Parameters

shipmentId
string<uuid>
required

Body

application/json
reason
string
required
Pattern: ^[A-Z][A-Z0-9_]{1,47}$
Example:

"CUSTOMER_UNREACHABLE"

Response

Minimal partner-safe shipment

id
string<uuid>
required
reference
string
required
status
enum<string>
required

ASSIGNED covers an offer awaiting the driver's acceptance and an accepted one. NO_DRIVER_AVAILABLE means the bounded driver search ended without a driver; the shipment can still be cancelled.

Available options:
CREATED,
ASSIGNED,
PICKED_UP,
OUT_FOR_DELIVERY,
DELIVERED,
FAILED,
NO_DRIVER_AVAILABLE,
CANCELLED
trackingUrl
string<uri-reference>
required
createdAt
string<date-time>
required
version
integer<int64>
required
Required range: x >= 0
codAmount
number<decimal> | null
Required range: x >= 0
deliveryFeeAmount
number<decimal> | null
Required range: x >= 0
deliveryFeeCurrency
string | null
Example:

"SAR"

eta
object | null
proofAvailable
boolean
proofType
enum<string> | null
Available options:
PHOTO,
SIGNATURE,
null
deliveredAt
string<date-time> | null
failureReasonCode
string | null
cancellationReasonCode
string | null
driver
object | null

The driver who accepted the shipment, while it is still moving. Phone number, surname, licence and identifiers are not disclosed; contact goes through the shipment conversation.