Create Slot Type

Create Slot Type

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/slot-types \
  --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"

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.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

	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("POST", 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.post("https://{base_url_domain}/api/global/v1/inventory/slot-types")
  .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")

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

request = Net::HTTP::Post.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

{
  "resource": {
    "type": "SlotType",
    "id": 54,
    "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
    },
    "created_at": "2026-08-01T14:03:22Z",
    "updated_at": "2026-08-01T14:03:22Z"
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

POST

inventory

slot-types

Create Slot Type

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/slot-types \
  --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"

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.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

	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("POST", 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.post("https://{base_url_domain}/api/global/v1/inventory/slot-types")
  .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")

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

request = Net::HTTP::Post.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

{
  "resource": {
    "type": "SlotType",
    "id": 54,
    "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
    },
    "created_at": "2026-08-01T14:03:22Z",
    "updated_at": "2026-08-01T14:03:22Z"
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Authorizations

Authorization

string

header

required

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.

Query Parameters

fields

enum<string>[]

Specify additional fields of the SlotType object to be included in the response.

Available options:

basic,

all,

name,

is_pickable,

sort_order,

patterns,

is_fixed_capacity,

slot_dimensions,

weight_capacity,

created_at,

updated_at

Body

application/json

name

string

required

The descriptive name of the slot type.

Maximum string length: 45

Example:

"Pickable Pallets"

is_pickable

boolean

Whether locations of this type are easy to pick from. Defaults to true.

Example:

true

sort_order

integer

The order in which this slot type's auto-assign patterns are tested, lowest first; among slot types sharing a sort order the newest is tested first. Defaults to 65535 (the maximum) so a new slot type is tested after every explicitly ordered type, but ahead of any older type also left at the maximum — including the built-in match-all Default type.

Required range: 0 <= x <= 65535

Example:

10

patterns

SlotTypePattern · object[]

Label patterns that automatically assign this slot type to matching locations. Stored in a canonical order rather than the submitted one.

Show child attributes

is_fixed_capacity

boolean

Whether slots of this type hold a fixed, known amount. Defaults to false.

Example:

true

slot_dimensions

DimensionsWHDNonNegative · object | null

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

weight_capacity

WeightNonNegative · object | null

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

Response

Slot type created.

resource

SlotType · object

The SlotType object allows locations with common attributes or purposes to be easily distinguishable. The slot type also determines if a location is pickable or not which may affect whether or not the location can be reserved for shipments when creating a batch.

A slot type may additionally declare a fixed physical capacity, which drives slot capacity and utilization calculations, and a list of label patterns that auto-assign the type to matching locations.

Show child attributes

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Query Parameters

Body

Response