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

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



## OpenAPI

````yaml PUT /v1/inventory/slot-types/{id}
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/{id}:
    put:
      tags:
        - SlotTypes
      summary: Update Slot Type
      description: >-
        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.
      operationId: updateSlotType
      parameters:
        - name: id
          in: path
          description: The `id` of the `SlotType`.
          schema:
            type: integer
            format: int32
            minimum: 1
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 45
                  description: The descriptive name of the slot type.
                  example: Pickable Pallets
                is_pickable:
                  type: boolean
                  description: Whether locations of this type are easy to pick from.
                  example: true
                sort_order:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >-
                    The order in which this slot type's auto-assign patterns are
                    tested, lowest first.
                  example: 10
                patterns:
                  type: array
                  description: >-
                    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.
                  items:
                    $ref: '#/components/schemas/Inventory_API_v1_Pattern'
                is_fixed_capacity:
                  type: boolean
                  description: Whether slots of this type hold a fixed, known amount.
                  example: true
                slot_dimensions:
                  $ref: >-
                    #/components/schemas/Inventory_API_v1_DimensionsWHDNonNegative
                weight_capacity:
                  $ref: '#/components/schemas/Inventory_API_v1_WeightNonNegative'
              additionalProperties: false
      responses:
        '200':
          $ref: '#/components/responses/Inventory_API_v1_200-ok-no-body'
        '400':
          $ref: '#/components/responses/Inventory_API_v1_400-bad-request'
        '404':
          $ref: '#/components/responses/Inventory_API_v1_404-not-found'
        '422':
          $ref: '#/components/responses/Inventory_API_v1_422-unprocessable'
        '500':
          $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error'
components:
  schemas:
    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_DimensionsWHDNonNegative:
      title: DimensionsWHDNonNegative
      type: object
      nullable: true
      description: >-
        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.
      required:
        - width
        - height
        - depth
      properties:
        width:
          type: number
          description: The width defined as a floating-point number up to 4 decimal places.
          format: float
          minimum: 0
          maximum: 99999999.999999
          example: 48
        height:
          type: number
          description: >-
            The height defined as a floating-point number up to 4 decimal
            places.
          format: float
          minimum: 0
          maximum: 99999999.999999
          example: 60
        depth:
          type: number
          description: The depth defined as a floating-point number up to 4 decimal places.
          format: float
          minimum: 0
          maximum: 99999999.999999
          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_200-ok-no-body:
      description: OK - The operation completed successfully and there is no response body.
    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_404-not-found:
      description: >-
        The requested resource was not found. It may have been deleted, it may
        have never existed, or you may not have permission to view it.
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      description: The error type code.
                      enum:
                        - not_found
                    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: not_found
                message: The server could not find the requested resource.
    Inventory_API_v1_422-unprocessable:
      description: >-
        There was an error processing 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:
                        - application
                        - unable_to_process
                    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: unable_to_process
                message: There was an error processing the request.
    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.

````