Create a new robot request

POST 
/robot-requests

Create a new robot request.

Request

application/json

Body

required

stationId uuidrequired
locationId stringrequired
requestType stringrequired

Possible values: [pickup, dropoff, empty]

load uuid
trolleyCount number
properties object
storeId uuid
from string

Possible values: [station, store]

message string

Responses

201

Robot request created

application/json

Schema

Schema

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

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

sku string[]
requestType string

Possible values: [pickup, dropoff, empty]

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

Possible values: [station, store]

message string
createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "locationId": "string",
  "missionLogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assignedRobot": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "load": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "requested",
  "sku": [
    "string"
  ],
  "requestType": "pickup",
  "trolleyCount": 0,
  "finishedAt": "2024-12-03T13:25:44.791Z",
  "processedAt": "2024-12-03T13:25:44.791Z",
  "approvedAt": "2024-12-03T13:25:44.791Z",
  "initiatedAt": "2024-12-03T13:25:44.791Z",
  "bufferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "properties": {},
  "storeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "from": "station",
  "message": "string",
  "createdAt": "2024-12-03T13:25:44.791Z",
  "updatedAt": "2024-12-03T13:25:44.791Z"
}

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

409

A robot request with the given details already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "A robot request with the given details already exists."
}

Example

{
  "message": "A robot request with the given details already exists."
}

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...