Skip to content
Bottle

Set where to leave a delivery

PUT
/track/leave
curl --request PUT \
  --url https://example.com/track/leave \
  --header 'Content-Type: application/json' \
  --data '{ "ref": "7K3M9-QWXZ2", "postcode": "KT3 4BP", "instruction": "none", "detail": "example", "saveToAddress": false }'

Deliberately unauthenticated, checked the same way as reading. Records what to do if nobody answers: do not leave it, leave it with a neighbour, or leave it in a safe place, with where. Written on this order, and on the delivery address as well when saveToAddress is true so the next order starts from it. The driver still decides at the door. Ignored once the order is delivered or cancelled.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
ref
required
string
>= 4 characters <= 24 characters
Example
7K3M9-QWXZ2
postcode
required
string
>= 3 characters <= 12 characters
Example
KT3 4BP
instruction
required
string
Allowed values: none neighbour safe_place
detail
string | null
<= 500 characters
saveToAddress
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Where the order is, with the instruction recorded

Media typeapplication/json
object
ref
required
string
business
required
string
fulfilment
required
string
Allowed values: delivery collection
postcode
required
string | null
items
required
Array<string>
status
required
string
Allowed values: awaiting_payment waiting planned on_the_way not_today delivered cancelled
day
required
string | null format: date
expected
required
object
from
required
string format: date
to
required
string format: date
window
required
object
from
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
to
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
position
required
object
yours
required
integer
> 0
total
required
integer
> 0
driverOn
required
integer | null
> 0
deliveredAt
required
string | null format: date-time
location
required
object
latitude
required
number
>= -90 <= 90
longitude
required
number
>= -180 <= 180
van
required
object
latitude
required
number
longitude
required
number
seenAt
required
string format: date-time
leave
required
object
instruction
required
string | null
Allowed values: none neighbour safe_place
detail
required
string | null
canSaveToAddress
required
boolean
Example
{
  "ref": "7K3M9-QWXZ2",
  "fulfilment": "delivery",
  "items": [
    "2 × 19kg propane"
  ],
  "status": "awaiting_payment",
  "window": {
    "from": "07:30",
    "to": "07:30"
  },
  "leave": {
    "instruction": "none"
  }
}

404

Section titled “404”

No order with that reference at that postcode

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

429

Section titled “429”

Too many attempts from one place

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}