Skip to main content
PATCH
/
v1
/
equipment
/
robots
/
{id}
Update robot
curl --request PATCH \
  --url http://localhost:3000/v1/equipment/robots/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": true,
  "active_tote_id": "<string>"
}
'
import requests

url = "http://localhost:3000/v1/equipment/robots/{id}"

payload = {
"is_active": True,
"active_tote_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({is_active: true, active_tote_id: '<string>'})
};

fetch('http://localhost:3000/v1/equipment/robots/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/equipment/robots/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_active' => true,
'active_tote_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "http://localhost:3000/v1/equipment/robots/{id}"

payload := strings.NewReader("{\n \"is_active\": true,\n \"active_tote_id\": \"<string>\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("http://localhost:3000/v1/equipment/robots/{id}")
.header("Content-Type", "application/json")
.body("{\n \"is_active\": true,\n \"active_tote_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/equipment/robots/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_active\": true,\n \"active_tote_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "robot": {
    "id": "011000001000020053",
    "display_id": "<string>",
    "label": "<string>",
    "name": "<string>",
    "is_active": true,
    "active_tote_id": "<string>"
  }
}
{
"error": "Not found"
}
{
"error": "Not found"
}
{
"error": "Not found"
}

Path Parameters

id
string
required

18-digit taxonomy ID

Example:

"011000001000020053"

Body

application/json
status
enum<string>
Available options:
idle,
delivering,
charging,
error
is_active
boolean
active_tote_id
string | null

Tote taxonomy ID to assign (null to unassign)

Response

Robot updated successfully

success
boolean
required
robot
object
required