Skip to content
Bottle

Update a delivery patch

PATCH
/patches/{id}
curl --request PATCH \
  --url https://example.com/patches/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "name": "example", "colour": "example", "areas": [ "example" ], "driverUserIds": [ "example" ], "takes": [ "consumer" ], "placedAfter": "example" }'

Rename it, change its areas, or give it to different drivers: driverUserIds replaces who has it, so moving a patch is one call.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 80 characters
colour
string | null
/^#[0-9a-fA-F]{6}$/
areas
Array<string>
<= 500 items
driverUserIds
Array<string>
<= 100 items
takes
Array<string>
<= 3 items
Allowed values: consumer trade online
placedAfter
string | null
/^([01]\d|2[0-3]):[0-5]\d$/

Responses

Section titled “Responses”

200

Section titled “200”

Updated

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
colour
required
string | null
/^#[0-9a-fA-F]{6}$/
areas
required
Array<string>
driverUserIds
required
Array<string>
takes
required
Array<string>
Allowed values: consumer trade online
placedAfter
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "name": "North London",
  "areas": [
    "N",
    "NW",
    "E"
  ],
  "takes": [
    "consumer"
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

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"
    }
  ]
}