Rockwell Automation Supply Items API

openapi: 3.2.0
info:
  title: Plex (Rockwell Automation) Connect Supply Items API
  version: '2026-10-20'
  description: Plex Smart Manufacturing Platform REST APIs, converted mechanically from the structured operation documents the Plex Developer Portal (developers.plex.com, a Rockwell Automation property) serves at /api/documentation/{api}/{operation}. No operations were authored by hand.
  x-generated-from: provider-documentation-json
  x-source: https://developers.plex.com/api/documentation/info
servers:
- url: https://connect.plex.com
  description: Production
- url: https://test.connect.plex.com
  description: Test (from https://developers.plex.com/api/sandbox/url)
security:
- PlexConnectApiKey: []
tags:
- name: Supply Items API
  description: The Supply Items API is used to manage supply item master data.
paths:
  /mdm/v1/supply-items/{id}/activate:
    post:
      operationId: activateSupplyItem
      summary: Activate Supply Item
      tags:
      - Supply Items API
      description: Activate a supply item.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '202':
          description: The request was accepted for processing.
        '400':
          description: A validation error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
        '404':
          description: The supply item does not exist.
      x-source: https://developers.plex.com/api/documentation/supply-items-api/activate-supply-item
  /mdm/v1/supply-items:
    post:
      operationId: createSupplyItem
      summary: Create Supply Item
      tags:
      - Supply Items API
      description: Create a supply item.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSupplyItemDto'
      responses:
        '201':
          description: The supply item was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyItemDto'
        '400':
          description: A validation error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
      x-source: https://developers.plex.com/api/documentation/supply-items-api/create-supply-item
    get:
      operationId: listSupplyItems_supplyItemsApi
      summary: List Supply Items
      tags:
      - Supply Items API
      description: List supply items based on query params.
      parameters:
      - name: id
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: A list of supply item IDs.
      - name: supplyItemNumber
        in: query
        required: false
        schema:
          type: string
          example: string
        description: A short identifier for the Supply Item.
      - name: type
        in: query
        required: false
        schema:
          type: string
          example: string
        description: 'Indicates the Supply Item type, such as office supplies or shop supplies.

          Setup Table: Item Type'
      - name: category
        in: query
        required: false
        schema:
          type: string
          example: string
        description: 'Setup Table: Supply Category'
      - name: priority
        in: query
        required: false
        schema:
          type: string
          example: string
        description: 'Setup Table: Item Priority'
      - name: group
        in: query
        required: false
        schema:
          type: string
          example: string
        description: 'A supply group, used to categorize Supply Items, such as Electrical, Mechanical, Office Supplies.

          Setup Table: Item Group'
      - name: createdById
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: The IAM Account ID of the user who created the record.
      - name: createdDateBegin
        in: query
        required: false
        schema:
          type: string
          format: date-time
          example: '2026-10-20T12:03:18Z'
        description: The date on which the record was created.
      - name: createdDateEnd
        in: query
        required: false
        schema:
          type: string
          format: date-time
          example: '2026-10-20T12:03:18Z'
        description: The date on which the record was created.
      - name: modifiedById
        in: query
        required: false
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description: The IAM Account ID of the user who last modified the record.
      - name: modifiedDateBegin
        in: query
        required: false
        schema:
          type: string
          format: date-time
          example: '2026-10-20T12:03:18Z'
        description: The date on which the record was last modified.
      - name: modifiedDateEnd
        in: query
        required: false
        schema:
          type: string
          format: date-time
          example: '2026-10-20T12:03:18Z'
        description: The date on which the record was last modified.
      responses:
        '200':
          description: The query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyItemDto'
      x-source: https://developers.plex.com/api/documentation/supply-items-api/list-supply-items
  /mdm/v1/supply-items/{id}/deactivate:
    post:
      operationId: deactivateSupplyItem
      summary: Deactivate Supply Item
      tags:
      - Supply Items API
      description: Deactivate a supply item.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '202':
          description: The request was accepted for processing.
        '400':
          description: A validation error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
        '404':
          description: The supply item does not exist.
      x-source: https://developers.plex.com/api/documentation/supply-items-api/deactivate-supply-item
  /mdm/v1/supply-items/{id}:
    delete:
      operationId: deleteSupplyItem
      summary: Delete Supply Item
      tags:
      - Supply Items API
      description: Delete a supply item.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: The supply item was successfully deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyItemDto'
        '400':
          description: A validation error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
        '404':
          description: The resource does not exist.
      x-source: https://developers.plex.com/api/documentation/supply-items-api/delete-supply-item
    get:
      operationId: getSupplyItem_supplyItemsApi
      summary: Get Supply Item
      tags:
      - Supply Items API
      description: Retrieve a supply item by ID.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: The query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyItemDto'
        '404':
          description: The resource does not exist.
      x-source: https://developers.plex.com/api/documentation/supply-items-api/get-supply-item
    put:
      operationId: updateSupplyItem
      summary: Update Supply Item
      tags:
      - Supply Items API
      description: Update a supply item.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSupplyItemDto'
      responses:
        '200':
          description: The supply item was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplyItemDto'
        '400':
          description: A validation error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
        '404':
          description: The resource does not exist.
      x-source: https://developers.plex.com/api/documentation/supply-items-api/update-supply-item
  /mdm/v1/supply-items/sync:
    post:
      operationId: syncSupplyItem
      summary: Sync Supply Item
      tags:
      - Supply Items API
      description: Add/Update multiple Supply Item records and their sub-resources. This operation performs create and update logic.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncSupplyItemDto'
      responses:
        '202':
          description: The request was accepted for processing.
        '400':
          description: A validation error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResponse'
      x-source: https://developers.plex.com/api/documentation/supply-items-api/sync-supply-item
components:
  schemas:
    SyncSupplyItemDto:
      type: object
      description: The full Supply Item Resource structure
      properties:
        id:
          type: string
          format: uuid
          description: A unique identifier for the Supply Item. This will be automatically generated if omitted from the request.
          example: 00000000-0000-0000-0000-000000000000
        supplyItemNumber:
          type: string
          description: A short identifier for the Supply Item.
          example: string
        type:
          type: string
          description: 'Indicates the Supply Item type, such as office supplies or shop supplies.

            Setup Table: Item Type'
          example: string
        category:
          type: string
          description: 'Setup Table: Supply Category'
          example: string
        priority:
          type: string
          description: 'Setup Table: Item Priority'
          example: string
        group:
          type: string
          description: 'A supply group, used to categorize Supply Items, such as Electrical, Mechanical, Office Supplies.

            Setup Table: Item Group'
          example: string
        customerUnitPrice:
          type: number
          format: double
          description: Customer price per unit.
          example: 0.1
        description:
          type: string
          description: Text description of the Supply Item.
          example: string
        inventoryUnit:
          type: string
          description: The unit of measure for the Supply Item.
          example: string
        briefDescription:
          type: string
          description: Short description of the Supply Item.
          example: string
        accountId:
          type: string
          format: uuid
          description: The default expense account for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerCode:
          type: string
          description: The manufacturer's code for the supply item. When this field is populated, the supplierId field cannot not be present in the request.
          example: string
        supplierId:
          type: string
          format: uuid
          description: The suppliers from whom the supplies are purchased. When this field is populated, the manufacturerCode cannot be present in the request.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerItemNumber:
          type: string
          description: The manufacturer's item number.
          example: string
        manufacturerItemRevision:
          type: string
          description: The manufacturer's revision number.
          example: string
        manufacturerText:
          type: string
          description: Notes about the manufacturer
          example: string
        taxCodeNumber:
          type: integer
          format: int32
          example: 0
        maxQuantity:
          type: number
          format: double
          description: The maximum number of Supply Items allowed to be in inventory.
          example: 0.1
        minQuantity:
          type: number
          format: double
          description: The minimum number of Supply Items allowed to be in inventory.
          example: 0.1
        note:
          type: string
          description: Purchasing notes.
          example: string
        updateWhenReceived:
          type: boolean
          description: Update inventory when supplies are received.
          example: false
        active:
          type: boolean
          example: false
        averageCost:
          type: number
          format: double
          description: Average cost of a Supply Item.
          example: 0.1
        responsiblePersonId:
          type: string
          format: uuid
          description: The ID of the person responsible for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        vendorManaged:
          type: boolean
          description: Vendor Managed flag
          example: false
        commodity:
          type: string
          example: string
        countryOfOrigin:
          type: string
          description: The country of origin of the Supply Item.
          example: string
        consignment:
          type: boolean
          example: false
      required:
      - supplyItemNumber
      - type
      - category
      - priority
      - group
      - inventoryUnit
    SupplyItemDto:
      type: object
      description: The Supply Item model.
      properties:
        id:
          type: string
          format: uuid
          description: 'A unique identifier for the Supply Item.

            This will be automatically generated if omitted from the request.'
          example: 00000000-0000-0000-0000-000000000000
        supplyItemNumber:
          type: string
          description: A short identifier for the Supply Item.
          example: string
        type:
          type: string
          description: 'Indicates the Supply Item type, such as office supplies or shop supplies.

            Setup Table: Item Type'
          example: string
        category:
          type: string
          description: 'Setup Table: Supply Category'
          example: string
        priority:
          type: string
          description: 'Setup Table: Item Priority'
          example: string
        group:
          type: string
          description: 'A supply group, used to categorize Supply Items, such as Electrical, Mechanical, Office Supplies.

            Setup Table: Item Group'
          example: string
        description:
          type: string
          description: Text description of the Supply Item.
          example: string
        customerUnitPrice:
          type: number
          format: double
          description: Customer price per unit.
          example: 0.1
        inventoryUnit:
          type: string
          description: The unit of measure for the Supply Item.
          example: string
        briefDescription:
          type: string
          description: Short description of the Supply Item.
          example: string
        accountId:
          type: string
          format: uuid
          description: The default expense account for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerCode:
          type: string
          description: The manufacturer's code for the Supply Item.
          example: string
        supplierId:
          type: string
          format: uuid
          description: The suppliers from whom the supplies are purchased.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerItemNumber:
          type: string
          description: The manufacturer's item number.
          example: string
        manufacturerItemRevision:
          type: string
          description: The manufacturer's revision number.
          example: string
        manufacturerText:
          type: string
          description: Notes about the manufacturer
          example: string
        createdDate:
          type: string
          format: date-time
          description: The date on which the record was created.
          example: '2026-10-20T12:03:18Z'
        createdById:
          type: string
          format: uuid
          description: The IAM Account ID of the user who created the record.
          example: 00000000-0000-0000-0000-000000000000
        modifiedDate:
          type: string
          format: date-time
          description: The date on which the record was last modified.
          example: '2026-10-20T12:03:18Z'
        modifiedById:
          type: string
          format: uuid
          description: The IAM Account ID of the user who last modified the record.
          example: 00000000-0000-0000-0000-000000000000
        taxCodeNumber:
          type: integer
          format: int32
          example: 0
        maxQuantity:
          type: number
          format: double
          description: The maximum number of Supply Items allowed to be in inventory.
          example: 0.1
        minQuantity:
          type: number
          format: double
          description: The minimum number of Supply Items allowed to be in inventory.
          example: 0.1
        note:
          type: string
          description: Purchasing notes.
          example: string
        updateWhenReceived:
          type: boolean
          description: Update inventory when supplies are received.
          example: false
        active:
          type: boolean
          example: false
        averageCost:
          type: number
          format: double
          description: Average cost of a Supply Item.
          example: 0.1
        responsiblePersonId:
          type: string
          format: uuid
          description: The ID of the person responsible for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        vendorManaged:
          type: boolean
          description: Vendor Managed flag
          example: false
        commodity:
          type: string
          example: string
        countryOfOrigin:
          type: string
          description: The country of origin of the Supply Item.
          example: string
        consignment:
          type: boolean
          example: false
    CreateSupplyItemDto:
      type: object
      description: The Supply Item model exposed for adding.
      properties:
        id:
          type: string
          format: uuid
          description: A unique identifier for the Supply Item. This will be automatically generated if omitted from the request.
          example: 00000000-0000-0000-0000-000000000000
        supplyItemNumber:
          type: string
          description: A short identifier for the Supply Item.
          example: string
        type:
          type: string
          description: 'Indicates the Supply Item type, such as office supplies or shop supplies.

            Setup Table: Item Type'
          example: string
        category:
          type: string
          description: 'Setup Table: Supply Category'
          example: string
        priority:
          type: string
          description: 'Setup Table: Item Priority'
          example: string
        group:
          type: string
          description: 'A supply group, used to categorize Supply Items, such as Electrical, Mechanical, Office Supplies.

            Setup Table: Item Group'
          example: string
        customerUnitPrice:
          type: number
          format: double
          description: Customer price per unit.
          example: 0.1
        description:
          type: string
          description: Text description of the Supply Item.
          example: string
        inventoryUnit:
          type: string
          description: The unit of measure for the Supply Item.
          example: string
        briefDescription:
          type: string
          description: Short description of the Supply Item.
          example: string
        accountId:
          type: string
          format: uuid
          description: The default expense account for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerCode:
          type: string
          description: The manufacturer's code for the supply item. When this field is populated, the supplierId field cannot not be present in the request.
          example: string
        supplierId:
          type: string
          format: uuid
          description: The suppliers from whom the supplies are purchased. When this field is populated, the manufacturerCode cannot be present in the request.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerItemNumber:
          type: string
          description: The manufacturer's item number.
          example: string
        manufacturerItemRevision:
          type: string
          description: The manufacturer's revision number.
          example: string
        manufacturerText:
          type: string
          description: Notes about the manufacturer
          example: string
        taxCodeNumber:
          type: integer
          format: int32
          example: 0
        maxQuantity:
          type: number
          format: double
          description: The maximum number of Supply Items allowed to be in inventory.
          example: 0.1
        minQuantity:
          type: number
          format: double
          description: The minimum number of Supply Items allowed to be in inventory.
          example: 0.1
        note:
          type: string
          description: Purchasing notes.
          example: string
        updateWhenReceived:
          type: boolean
          description: Update inventory when supplies are received.
          example: false
        active:
          type: boolean
          example: false
        averageCost:
          type: number
          format: double
          description: Average cost of a Supply Item.
          example: 0.1
        responsiblePersonId:
          type: string
          format: uuid
          description: The ID of the person responsible for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        vendorManaged:
          type: boolean
          description: Vendor Managed flag
          example: false
        commodity:
          type: string
          example: string
        countryOfOrigin:
          type: string
          description: The country of origin of the Supply Item.
          example: string
        consignment:
          type: boolean
          example: false
      required:
      - supplyItemNumber
      - type
      - category
      - priority
      - group
      - inventoryUnit
    UpdateSupplyItemDto:
      type: object
      description: The Supply Item model exposed for updating.
      properties:
        supplyItemNumber:
          type: string
          description: A short identifier for the Supply Item.
          example: string
        type:
          type: string
          description: 'Indicates the Supply Item type, such as office supplies or shop supplies.

            Setup Table: Item Type'
          example: string
        category:
          type: string
          description: 'Setup Table: Supply Category'
          example: string
        priority:
          type: string
          description: 'Setup Table: Item Priority'
          example: string
        group:
          type: string
          description: 'A supply group, used to categorize Supply Items, such as Electrical, Mechanical, Office Supplies.

            Setup Table: Item Group'
          example: string
        customerUnitPrice:
          type: number
          format: double
          description: Customer price per unit.
          example: 0.1
        description:
          type: string
          description: Text description of the Supply Item.
          example: string
        inventoryUnit:
          type: string
          description: The unit of measure for the Supply Item.
          example: string
        briefDescription:
          type: string
          description: Short description of the Supply Item.
          example: string
        accountId:
          type: string
          format: uuid
          description: The default expense account for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerCode:
          type: string
          description: The manufacturer's code for the supply item. When this field is populated, the supplierId field cannot not be present in the request.
          example: string
        supplierId:
          type: string
          format: uuid
          description: The suppliers from whom the supplies are purchased. When this field is populated, the manufacturerCode cannot be present in the request.
          example: 00000000-0000-0000-0000-000000000000
        manufacturerItemNumber:
          type: string
          description: The manufacturer's item number.
          example: string
        manufacturerItemRevision:
          type: string
          description: The manufacturer's revision number.
          example: string
        manufacturerText:
          type: string
          description: Notes about the manufacturer
          example: string
        taxCodeNumber:
          type: integer
          format: int32
          example: 0
        maxQuantity:
          type: number
          format: double
          description: The maximum number of Supply Items allowed to be in inventory.
          example: 0.1
        minQuantity:
          type: number
          format: double
          description: The minimum number of Supply Items allowed to be in inventory.
          example: 0.1
        note:
          type: string
          description: Purchasing notes.
          example: string
        updateWhenReceived:
          type: boolean
          description: Update inventory when supplies are received.
          example: false
        active:
          type: boolean
          example: false
        averageCost:
          type: number
          format: double
          description: Average cost of a Supply Item.
          example: 0.1
        responsiblePersonId:
          type: string
          format: uuid
          description: The ID of the person responsible for the Supply Item.
          example: 00000000-0000-0000-0000-000000000000
        vendorManaged:
          type: boolean
          example: false
        commodity:
          type: string
          example: string
        countryOfOrigin:
          type: string
          description: The country of origin of the Supply Item.
          example: string
        consignment:
          type: boolean
          example: false
      required:
      - supplyItemNumber
      - type
      - category
      - priority
      - group
      - inventoryUnit
    ValidationResponse:
      type: object
      properties:
        code:
          type: string
          example: string
        message:
          type: string
          example: string
        errors:
          type: array
          items:
            type: object
            properties: {}
  securitySchemes:
    PlexConnectApiKey:
      type: apiKey
      in: header
      name: X-Plex-Connect-Api-Key
      description: 'Subscription key (Consumer Key of an app created in the Plex Developer Portal). Source: https://developers.plex.com/getstarted'