Cancel robot request

DELETE 
/robot-requests/cancel/:id

Cancel a robot request by ID.

Request

Path Parameters

id stringrequired

The ID of the robot request to cancel

Query Parameters

from string

Possible values: [store, station]

The source of the request

Responses

200

Robot request cancelled

application/json

Schema

Schema

_id uuid
stationId object
locationId string
missionLogId uuid
assignedRobot uuid
load object
status string

Possible values: [cancelled, requested, processing, approved, initiated, completed, aborted]

sku string[]
requestType string

Possible values: [pickup, dropoff, empty]

trolleyCount number
processedAt date-time
approvedAt date-time
initiatedAt date-time
bufferId object
properties object
storeId uuid
from string

Possible values: [station, store]

message string
createdAt date-time
updatedAt date-time
finishedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stationId": {},
  "locationId": "string",
  "missionLogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assignedRobot": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "load": {},
  "status": "cancelled",
  "sku": [
    "string"
  ],
  "requestType": "pickup",
  "trolleyCount": 0,
  "processedAt": "2025-06-05T13:40:40.578Z",
  "approvedAt": "2025-06-05T13:40:40.578Z",
  "initiatedAt": "2025-06-05T13:40:40.578Z",
  "bufferId": {},
  "properties": {},
  "storeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "from": "station",
  "message": "string",
  "createdAt": "2025-06-05T13:40:40.578Z",
  "updatedAt": "2025-06-05T13:40:40.578Z",
  "finishedAt": "2025-06-05T13:40:40.578Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...