Skip to content
Bottle

Remove a delivery partner

DELETE
/delivery-partners/{id}
curl --request DELETE \
  --url https://example.com/delivery-partners/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Deleted if no order has ever used it. Once one has, it is archived instead: it can no longer be chosen, and its orders still name it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

What became of it

Media typeapplication/json
object
outcome
required
string
Allowed values: deleted archived

Example 

{
  "outcome": "deleted"
}

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, without the permission this needs, or on a plan without delivery partners

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

409

Section titled “409”

Refused, with the reason

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