> ## Documentation Index > Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt > Use this file to discover all available pages before exploring further. # List Slot Types > Returns a list of `SlotType` objects. The default field set is the small one embedded on `Location` responses (`id`, `name`, `is_pickable`); request `fields=all` for the management fields such as `sort_order`, `patterns` and the capacity measurements. ## OpenAPI ````yaml GET /v1/inventory/slot-types openapi: 3.0.3 info: title: ShipStream version: '1.0' license: name: Commercial (Copyright 2025 - All Rights Reserved) url: https://shipstream.io contact: name: ShipStream Support email: help@shipstream.io termsOfService: https://shipstream.io/legal/api-terms/ servers: - url: https://{base_url_domain}/api/global description: Direct API Url variables: base_url_domain: default: example.shipstream.app description: >- The fully qualified domain name for your ShipStream WMS instance. This is either a custom domain, or a subdomain of shipstream.app, and will be the same as the domain name for the page which you use to login to ShipStream WMS. security: - ShipStream_bearerAuth: [] tags: - name: Warehouses x-displayName: Warehouses - name: Products x-displayName: Products - name: ProductProfiles x-displayName: ProductProfiles - name: HandlingClasses x-displayName: HandlingClasses - name: Locations x-displayName: Locations - name: LocationTags x-displayName: LocationTags - name: SlotTypes x-displayName: SlotTypes - name: Levels x-displayName: Levels - name: HoldReasons x-displayName: HoldReasons - name: Holds x-displayName: Holds - name: Replenishment x-displayName: Replenishment - name: LocationProfiles x-displayName: LocationProfiles - name: SlottingRules x-displayName: SlottingRules - name: Deliveries description: Every thing about a Delivery Receiving x-displayName: Deliveries - name: Shipments x-displayName: Shipments - name: Orders x-displayName: Orders - name: Retailers x-displayName: Retailers - name: Users x-displayName: Users - name: User Roles x-displayName: User Roles - name: Merchants x-displayName: Merchants - name: Healthcheck x-displayName: Healthcheck paths: /v1/inventory/slot-types: get: tags: - SlotTypes summary: List Slot Types description: >- Returns a list of `SlotType` objects. The default field set is the small one embedded on `Location` responses (`id`, `name`, `is_pickable`); request `fields=all` for the management fields such as `sort_order`, `patterns` and the capacity measurements. operationId: getSlotTypes parameters: - $ref: '#/components/parameters/Inventory_API_v1_slot_type-fields' - name: filter in: query schema: type: array items: type: string required: false style: form explode: true allowReserved: true description: >- Using the [filtering syntax](/global-api/filtering-syntax), you may filter the results using the following fields: - `id` - `name` - `sort_order` - `is_pickable` — supports only the `eq` and `neq` operators - `is_fixed_capacity` - `created_at` - `updated_at` examples: Pickable only: summary: Only slot types whose locations are pickable. value: - is_pickable:true Fixed capacity only: summary: Only slot types that declare a fixed capacity. value: - is_fixed_capacity:true - name: sort in: query required: false schema: type: string description: >- The default sort order is **descending** by primary key (`sort=-id`). Using the [sorting syntax](/global-api/sorting-syntax), the following fields are available for sorting: - `id` - `name` - `sort_order` - `created_at` - `updated_at` - $ref: '#/components/parameters/Inventory_API_v1_count' - $ref: '#/components/parameters/Inventory_API_v1_cursor_end' - $ref: '#/components/parameters/Inventory_API_v1_cursor_start' - $ref: '#/components/parameters/Inventory_API_v1_limit' responses: '200': description: >- A dictionary with a `collection` property that contains an array of up to `limit` `SlotType` objects. If no slot types are found the array will be empty. content: application/json: schema: type: object properties: collection: type: array description: A list of `SlotType` objects. items: $ref: '#/components/schemas/Inventory_API_v1_SlotType' has_more: $ref: '#/components/schemas/Inventory_API_v1_has_more' next: $ref: '#/components/schemas/Inventory_API_v1_next' previous: $ref: '#/components/schemas/Inventory_API_v1_previous' meta: $ref: '#/components/schemas/Inventory_API_v1_meta' '400': $ref: '#/components/responses/Inventory_API_v1_400-bad-request' '500': $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error' components: parameters: Inventory_API_v1_slot_type-fields: name: fields in: query required: false description: >- Specify additional fields of the `SlotType` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information. explode: false schema: $ref: '#/components/schemas/Inventory_API_v1_slot_type-fields-enum' Inventory_API_v1_count: name: count in: query description: >- If specified as `1`, the `meta.count` property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the `next` property of the response. See [paging parameters](/global-api/paging-parameters) for more information. style: form schema: type: integer minimum: 0 maximum: 1 Inventory_API_v1_cursor_end: name: cursor_end in: query description: >- A cursor for use in pagination which defines the last `id` of the next page of results, non-inclusive. See [paging parameters](/global-api/paging-parameters) for more information on paging. schema: type: integer style: form Inventory_API_v1_cursor_start: name: cursor_start in: query description: >- A cursor for use in pagination which defines the starting `id` of the next page of results. See [paging parameters](/global-api/paging-parameters) for more information on paging. schema: type: integer style: form Inventory_API_v1_limit: name: limit in: query description: A limit on the number of objects to be returned. style: form schema: type: integer example: 100 default: 100 minimum: 1 maximum: 1000 schemas: Inventory_API_v1_SlotType: title: SlotType type: object description: >- 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. properties: type: type: string enum: - SlotType readOnly: true description: >- This is a read-only property that describes the type of object in the response body. id: type: integer example: 54 description: >- The internal `id` property used as a path parameter in a resource lookup. name: type: string maxLength: 45 description: The descriptive name of the slot type, unique across slot types. example: Pickable Pallets is_pickable: type: boolean description: >- Whether or not the location is considered to be easy to pick from for the purpose of generating pickable batches. default: true sort_order: type: integer minimum: 0 maximum: 65535 example: 10 description: >- 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. The first pattern to match a location label decides its slot type.\ `Optional Field` patterns: type: array description: >- Label patterns that automatically assign this slot type to matching locations. Stored in a canonical order, which is not necessarily the order they were submitted in.\ `Optional Field` items: $ref: '#/components/schemas/Inventory_API_v1_Pattern' is_fixed_capacity: type: boolean example: true description: >- Whether slots of this type hold a fixed, known amount, making them eligible for slot capacity and utilization calculations. When enabled, all three slot dimensions are required.\ `Optional Field` slot_dimensions: description: |- The interior dimensions of slots assigned to this slot type.\ `Optional Field` allOf: - $ref: '#/components/schemas/Inventory_API_v1_DimensionsWHD' weight_capacity: description: >- The maximum weight a slot of this type may hold, used to clamp computed slot capacities. Must not be negative.\ `Optional Field` allOf: - $ref: '#/components/schemas/Inventory_API_v1_WeightNonNegative' created_at: type: string format: date-time nullable: true example: '2026-08-01T14:03:22Z' description: |- The UTC date and time the slot type was created.\ `Optional Field` updated_at: type: string format: date-time nullable: true example: '2026-08-01T14:03:22Z' description: |- The UTC date and time the slot type was last modified.\ `Optional Field` required: - type - id additionalProperties: false Inventory_API_v1_has_more: type: boolean description: |- True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results. Inventory_API_v1_next: type: string nullable: true description: The resource path for the next page of results if any are expected. Inventory_API_v1_previous: type: string nullable: true description: The resource path for the previous page of results if any are expected. Inventory_API_v1_meta: type: object properties: processing_time: type: number description: Total time in which request is processed and response is sent back. example: 0.2525252525 cursor_start: type: integer description: >- A cursor for use in pagination which defines the starting `id` of the next page of results. See [paging parameters](/global-api/paging-parameters) for more information on paging. nullable: true cursor_end: type: integer description: >- A cursor for use in pagination which defines the last `id` of the next page of results, non-inclusive. See [paging parameters](/global-api/paging-parameters) for more information on paging. nullable: true count: type: integer description: >- The total number of items matching the query before applying paging parameters. This field is only present if the query parameter `count=1` is present in the request. description: Additional metadata pertaining to the response. Inventory_API_v1_slot_type-fields-enum: title: SlotType description: >- Specify additional fields of the `SlotType` object to be included in the response. type: array items: type: string enum: - basic - all - name - is_pickable - sort_order - patterns - is_fixed_capacity - slot_dimensions - weight_capacity - created_at - updated_at Inventory_API_v1_Pattern: title: SlotTypePattern type: object description: >- A rule that assigns its slot type to every location whose label matches `regex`, applied only to locations that are still set to automatic slot type assignment. properties: description: type: string example: Pallet racks on aisles A through D description: An explanation of which locations the pattern is meant to capture. regex: type: string example: P-[A-D]-\d+ description: A regular expression matched against the whole location label. warehouses: type: array description: >- The warehouses the pattern applies to. An empty list, or omitting the property on a request, applies it to every warehouse. Always present in responses. items: $ref: '#/components/schemas/Inventory_API_v1_WarehouseRef' required: - description - regex additionalProperties: false Inventory_API_v1_DimensionsWHD: title: DimensionsWHD type: object nullable: true properties: width: type: number description: The width defined as a floating-point number up to 4 decimal places. format: float example: 48 height: type: number description: >- The height defined as a floating-point number up to 4 decimal places. format: float example: 60 depth: type: number description: The depth defined as a floating-point number up to 4 decimal places. format: float example: 42 unit: $ref: '#/components/schemas/Inventory_API_v1_LengthUnit' Inventory_API_v1_WeightNonNegative: title: WeightNonNegative type: object nullable: true description: >- 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. required: - value properties: value: type: number description: >- The weight quantity defined as a floating point value of up to 4 decimal places. format: float minimum: 0 maximum: 99999999.999999 example: 20 unit: $ref: '#/components/schemas/Inventory_API_v1_WeightUnit' Inventory_API_v1_WarehouseRef: title: WarehouseRef type: object description: A reference to a `Warehouse` by `id`. properties: type: type: string enum: - Warehouse description: This property describes the type of object in the response body. id: type: integer format: int32 description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id nullable: true additionalProperties: false Inventory_API_v1_LengthUnit: type: string description: The imperical or metric unit of measurement. enum: - in - mm - cm - m Inventory_API_v1_WeightUnit: type: string description: This can be an imperial or metric unit for weight. enum: - lb - oz - kg - g responses: Inventory_API_v1_400-bad-request: description: >- The request was invalid. The client must change the request. See the response body for more details. content: application/json: schema: type: object properties: errors: type: array items: type: object properties: type: type: string description: The error type code. enum: - parser - parameters - openapi message: type: string description: An English sentence describing the error type. details: type: array description: >- An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid. items: type: object properties: key: type: string description: The path to the key which relates to the error. message: type: string description: >- An English sentence describing the details of the error. additionalProperties: false additionalProperties: false minItems: 1 additionalProperties: false example: errors: - type: parameters message: The supplied parameters are invalid. Inventory_API_v1_500-internal-server-error: description: >- Internal Server Error - Something wrong happened at server side. Contact server administrator for more details. securitySchemes: ShipStream_bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- 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. ````