> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Toolswork load equipment

> Bulk load equipment with groupings and weights; supports on-the-fly grouping creation.



## OpenAPI

````yaml /user-docs/api-reference/external-openapi.json post /ims/equipment/load-toolswork
openapi: 3.1.0
info:
  title: ARMS External API
  version: 1.0.0
  description: >-
    OpenAPI specification generated from external API schemas. Endpoints require
    query parameter carrierId and headers x-arms-api-key and x-arms-assume-user.
  license:
    name: Proprietary
    url: https://cedarai.com
servers:
  - url: https://api-lg.arms.cedarai.com
    description: Production (US)
  - url: https://api-lg.arms.cedarai.se
    description: Production (EU)
security:
  - ApiKeyAuth: []
    AssumeUser: []
paths:
  /ims/equipment/load-toolswork:
    post:
      summary: Toolswork load equipment
      description: >-
        Bulk load equipment with groupings and weights; supports on-the-fly
        grouping creation.
      operationId: toolsworkLoadEquipment
      parameters:
        - $ref: '#/components/parameters/CarrierId'
        - $ref: '#/components/parameters/ViewAsUserGroup'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolsWorkLoadEquipmentInput'
            examples:
              example1:
                summary: Load toolswork with 2 equipment
                value:
                  carrierId: 1
                  details:
                    - initialAndNumber: HUEH 862431
                      netWeightTons: 2000
                      grossWeightTons: 3000
                      comments: very nice
                      groupings:
                        - type: bin
                          name: bin 0
                        - type: ash type
                          name: ash type 0
                    - initialAndNumber: YHZT 582774
                      netWeightTons: 2000
                      grossWeightTons: 3000
                      groupings:
                        - type: bin
                          name: bin 1
                        - type: ash type
                          name: ash type 1
                  trackName: Jacob Flores
                  waybillTemplateId: 11
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolsWorkLoadEquipmentOutput'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    CarrierId:
      name: carrierId
      in: query
      required: true
      schema:
        type: integer
      description: Carrier identifier; required for all endpoints
    ViewAsUserGroup:
      name: viewAsUserGroup
      in: query
      required: false
      schema:
        type: string
      description: Optional user group context
  schemas:
    ToolsWorkLoadEquipmentInput:
      type: object
      properties:
        carrierId:
          type: integer
          description: Carrier identifier for the load.
        details:
          type: array
          description: List of equipment and attributes to load.
          items:
            $ref: '#/components/schemas/ToolsWorkLoadEquipmentDetails'
        trackName:
          type: string
          description: Track name where toolswork is loaded.
        timestamp:
          type: string
          description: Optional timestamp of the load event.
        waybillTemplateId:
          type: integer
          description: Waybill template identifier to use for the load.
      required:
        - carrierId
        - details
        - trackName
        - waybillTemplateId
    ToolsWorkLoadEquipmentOutput:
      type: object
      properties: {}
    Error:
      type: object
      properties:
        message:
          type: string
    ToolsWorkLoadEquipmentDetails:
      type: object
      properties:
        initialAndNumber:
          type: string
          description: Equipment mark and number (e.g., 'HUEH 862431').
        netWeightTons:
          type: number
          description: Net weight in tons.
        grossWeightTons:
          type: number
          description: Gross weight in tons.
        tareWeightTons:
          type: number
          description: Tare weight in tons.
        groupings:
          type: array
          description: >-
            Groupings to attach to the equipment (created on the fly if
            missing).
          items:
            $ref: '#/components/schemas/ToolsWorkLoadGroupingDetails'
        comments:
          type: string
          description: Optional comments or notes.
        sequence:
          type: integer
          description: Optional sequence ordering for the load list.
      required:
        - initialAndNumber
        - netWeightTons
        - groupings
    ToolsWorkLoadGroupingDetails:
      type: object
      properties:
        type:
          type: string
          description: Grouping type (e.g., bin, ash type).
        name:
          type: string
          description: Grouping name to associate with the loaded equipment.
      required:
        - type
        - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-arms-api-key
      description: Your ARMS API key
    AssumeUser:
      type: apiKey
      in: header
      name: x-arms-assume-user
      description: Email of a user assigned to the appropriate user group

````