curl --request PUT \
--url https://{base_url_domain}/api/global/v1/inventory/slot-types/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Pickable Pallets",
"is_pickable": true,
"sort_order": 10,
"patterns": [
{
"description": "Pallet racks on aisles A through D",
"regex": "P-[A-D]-\\d+",
"warehouses": [
{
"type": "Warehouse",
"id": 123
}
]
}
],
"is_fixed_capacity": true,
"slot_dimensions": {
"width": 48,
"height": 60,
"depth": 42
},
"weight_capacity": {
"value": 20
}
}
'import requests
url = "https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}"
payload = {
"name": "Pickable Pallets",
"is_pickable": True,
"sort_order": 10,
"patterns": [
{
"description": "Pallet racks on aisles A through D",
"regex": "P-[A-D]-\d+",
"warehouses": [
{
"type": "Warehouse",
"id": 123
}
]
}
],
"is_fixed_capacity": True,
"slot_dimensions": {
"width": 48,
"height": 60,
"depth": 42
},
"weight_capacity": { "value": 20 }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Pickable Pallets',
is_pickable: true,
sort_order: 10,
patterns: [
{
description: 'Pallet racks on aisles A through D',
regex: 'P-[A-D]-\d+',
warehouses: [{type: 'Warehouse', id: 123}]
}
],
is_fixed_capacity: true,
slot_dimensions: {width: 48, height: 60, depth: 42},
weight_capacity: {value: 20}
})
};
fetch('https://{base_url_domain}/api/global/v1/inventory/slot-types/{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_URL => "https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Pickable Pallets',
'is_pickable' => true,
'sort_order' => 10,
'patterns' => [
[
'description' => 'Pallet racks on aisles A through D',
'regex' => 'P-[A-D]-\\d+',
'warehouses' => [
[
'type' => 'Warehouse',
'id' => 123
]
]
]
],
'is_fixed_capacity' => true,
'slot_dimensions' => [
'width' => 48,
'height' => 60,
'depth' => 42
],
'weight_capacity' => [
'value' => 20
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}"
payload := strings.NewReader("{\n \"name\": \"Pickable Pallets\",\n \"is_pickable\": true,\n \"sort_order\": 10,\n \"patterns\": [\n {\n \"description\": \"Pallet racks on aisles A through D\",\n \"regex\": \"P-[A-D]-\\\\d+\",\n \"warehouses\": [\n {\n \"type\": \"Warehouse\",\n \"id\": 123\n }\n ]\n }\n ],\n \"is_fixed_capacity\": true,\n \"slot_dimensions\": {\n \"width\": 48,\n \"height\": 60,\n \"depth\": 42\n },\n \"weight_capacity\": {\n \"value\": 20\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Pickable Pallets\",\n \"is_pickable\": true,\n \"sort_order\": 10,\n \"patterns\": [\n {\n \"description\": \"Pallet racks on aisles A through D\",\n \"regex\": \"P-[A-D]-\\\\d+\",\n \"warehouses\": [\n {\n \"type\": \"Warehouse\",\n \"id\": 123\n }\n ]\n }\n ],\n \"is_fixed_capacity\": true,\n \"slot_dimensions\": {\n \"width\": 48,\n \"height\": 60,\n \"depth\": 42\n },\n \"weight_capacity\": {\n \"value\": 20\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Pickable Pallets\",\n \"is_pickable\": true,\n \"sort_order\": 10,\n \"patterns\": [\n {\n \"description\": \"Pallet racks on aisles A through D\",\n \"regex\": \"P-[A-D]-\\\\d+\",\n \"warehouses\": [\n {\n \"type\": \"Warehouse\",\n \"id\": 123\n }\n ]\n }\n ],\n \"is_fixed_capacity\": true,\n \"slot_dimensions\": {\n \"width\": 48,\n \"height\": 60,\n \"depth\": 42\n },\n \"weight_capacity\": {\n \"value\": 20\n }\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid."
}
]
}{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "There was an error processing the request."
}
]
}Update Slot Type
Partially updates a SlotType specified by its id path parameter. Only the properties
present in the request body are changed; sending patterns replaces the whole list.
Changing the slot dimensions or is_fixed_capacity queues the affected locations for
capacity recalculation, so a change is not reflected in utilization figures until those
jobs run.
curl --request PUT \
--url https://{base_url_domain}/api/global/v1/inventory/slot-types/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Pickable Pallets",
"is_pickable": true,
"sort_order": 10,
"patterns": [
{
"description": "Pallet racks on aisles A through D",
"regex": "P-[A-D]-\\d+",
"warehouses": [
{
"type": "Warehouse",
"id": 123
}
]
}
],
"is_fixed_capacity": true,
"slot_dimensions": {
"width": 48,
"height": 60,
"depth": 42
},
"weight_capacity": {
"value": 20
}
}
'import requests
url = "https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}"
payload = {
"name": "Pickable Pallets",
"is_pickable": True,
"sort_order": 10,
"patterns": [
{
"description": "Pallet racks on aisles A through D",
"regex": "P-[A-D]-\d+",
"warehouses": [
{
"type": "Warehouse",
"id": 123
}
]
}
],
"is_fixed_capacity": True,
"slot_dimensions": {
"width": 48,
"height": 60,
"depth": 42
},
"weight_capacity": { "value": 20 }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Pickable Pallets',
is_pickable: true,
sort_order: 10,
patterns: [
{
description: 'Pallet racks on aisles A through D',
regex: 'P-[A-D]-\d+',
warehouses: [{type: 'Warehouse', id: 123}]
}
],
is_fixed_capacity: true,
slot_dimensions: {width: 48, height: 60, depth: 42},
weight_capacity: {value: 20}
})
};
fetch('https://{base_url_domain}/api/global/v1/inventory/slot-types/{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_URL => "https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Pickable Pallets',
'is_pickable' => true,
'sort_order' => 10,
'patterns' => [
[
'description' => 'Pallet racks on aisles A through D',
'regex' => 'P-[A-D]-\\d+',
'warehouses' => [
[
'type' => 'Warehouse',
'id' => 123
]
]
]
],
'is_fixed_capacity' => true,
'slot_dimensions' => [
'width' => 48,
'height' => 60,
'depth' => 42
],
'weight_capacity' => [
'value' => 20
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}"
payload := strings.NewReader("{\n \"name\": \"Pickable Pallets\",\n \"is_pickable\": true,\n \"sort_order\": 10,\n \"patterns\": [\n {\n \"description\": \"Pallet racks on aisles A through D\",\n \"regex\": \"P-[A-D]-\\\\d+\",\n \"warehouses\": [\n {\n \"type\": \"Warehouse\",\n \"id\": 123\n }\n ]\n }\n ],\n \"is_fixed_capacity\": true,\n \"slot_dimensions\": {\n \"width\": 48,\n \"height\": 60,\n \"depth\": 42\n },\n \"weight_capacity\": {\n \"value\": 20\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Pickable Pallets\",\n \"is_pickable\": true,\n \"sort_order\": 10,\n \"patterns\": [\n {\n \"description\": \"Pallet racks on aisles A through D\",\n \"regex\": \"P-[A-D]-\\\\d+\",\n \"warehouses\": [\n {\n \"type\": \"Warehouse\",\n \"id\": 123\n }\n ]\n }\n ],\n \"is_fixed_capacity\": true,\n \"slot_dimensions\": {\n \"width\": 48,\n \"height\": 60,\n \"depth\": 42\n },\n \"weight_capacity\": {\n \"value\": 20\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/inventory/slot-types/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Pickable Pallets\",\n \"is_pickable\": true,\n \"sort_order\": 10,\n \"patterns\": [\n {\n \"description\": \"Pallet racks on aisles A through D\",\n \"regex\": \"P-[A-D]-\\\\d+\",\n \"warehouses\": [\n {\n \"type\": \"Warehouse\",\n \"id\": 123\n }\n ]\n }\n ],\n \"is_fixed_capacity\": true,\n \"slot_dimensions\": {\n \"width\": 48,\n \"height\": 60,\n \"depth\": 42\n },\n \"weight_capacity\": {\n \"value\": 20\n }\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid."
}
]
}{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "There was an error processing the request."
}
]
}Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
The id of the SlotType.
x >= 1Body
The descriptive name of the slot type.
45"Pickable Pallets"
Whether locations of this type are easy to pick from.
true
The order in which this slot type's auto-assign patterns are tested, lowest first.
0 <= x <= 6553510
Label patterns that automatically assign this slot type to matching locations, replacing the existing list. Stored in a canonical order rather than the submitted one.
Show child attributes
Show child attributes
Whether slots of this type hold a fixed, known amount.
true
Interior dimensions that describe physical extents, so none of them may be negative. All three
axes are supplied together; send null rather than a partial object to clear them.
Show child attributes
Show child attributes
A weight that describes a capacity or an allowance rather than a measurement, and so cannot be
negative. Send null rather than an object without a value to clear a stored weight.
Show child attributes
Show child attributes
Response
OK - The operation completed successfully and there is no response body.
Was this page helpful?