ECI Solutions Inventory API

openapi: 3.2.0
info:
  title: Lasso Inventory API
  description: 'Overview


    Use this API to manage Registrant, Project, and Inventory data within Lasso CRM.'
  version: 1.0.39
servers:
- url: https://api.lassocrm.com/v1
  description: Production endpoint
tags:
- name: Inventory
paths:
  /inventory/search:
    get:
      summary: Search inventories by strataLot and inventoryNumber
      operationId: get_inventory_search
      description: This endpoint is optimized for speed with a smaller payload than `/inventory`. This is handy for live search features, e.g. a drop-down with suggested results for a search bar.
      tags:
      - Inventory
      parameters:
      - name: strataLot
        in: query
        schema:
          type: string
        description: /inventory/search?strataLot=123
      - name: inventoryNumber
        in: query
        schema:
          type: string
        description: /inventory/search?inventoryNumber=123
      security:
      - JwtAuthorizer: []
      responses:
        200:
          description: Inventories found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InventoryRead'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        500:
          $ref: '#/components/responses/InternalServerError'
  /inventory:
    get:
      summary: Returns a list of all inventories
      operationId: get_inventory
      tags:
      - Inventory
      security:
      - JwtAuthorizer: []
      responses:
        200:
          description: Inventories found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InventoryRead'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        500:
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Inventory
      summary: Create an inventory
      operationId: post_inventory_search
      description: Creates an inventory, if no component is specified the default is used.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryCreate'
      security:
      - JwtAuthorizer: []
      responses:
        201:
          description: Inventory created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryRead'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        409:
          $ref: '#/components/responses/ErrorInventoryAlreadySynced'
        500:
          $ref: '#/components/responses/InternalServerError'
  /inventory/{inventoryId}:
    parameters:
    - in: path
      name: inventoryId
      schema:
        type: string
      required: true
      description: /inventory/123
    get:
      tags:
      - Inventory
      summary: Get a single inventory
      operationId: get_inventory_by_id
      security:
      - JwtAuthorizer: []
      responses:
        200:
          description: Return an inventory item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryFull'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - Inventory
      summary: Update an inventory
      operationId: put_inventory
      description: Updates an inventory. Note that this will overwrite all of the inventory's information with the entity provided in the request payload. To avoid accidentally deleting existing information, first perform a GET on the same resource, then modify the returned entity, then finally apply the entity through this PUT method.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryUpdate'
      security:
      - JwtAuthorizer: []
      responses:
        200:
          description: Inventory updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryRead'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        409:
          $ref: '#/components/responses/ErrorInventoryAlreadySynced'
        500:
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Inventory
      summary: Delete an inventory
      operationId: delete_inventory
      description: Deletes an inventory, in order to remove an inventory it must have a status of "Available" and not be "locked"
      security:
      - JwtAuthorizer: []
      responses:
        204:
          description: Inventory deleted
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        409:
          $ref: '#/components/responses/ErrorInventoryCannotBeDeleted'
        500:
          $ref: '#/components/responses/InternalServerError'
  /inventory/{inventoryId}/sync:
    parameters:
    - in: path
      name: inventoryId
      schema:
        type: string
      required: true
      description: /inventory/123/sync
    put:
      tags:
      - Inventory
      summary: Sync an inventory
      operationId: put_inventory_sync
      description: Syncs an inventory item with Lasso. This can only be done once, afterwards Lasso will reject any subsequent PUT request with a 409 error. This is done to prevent accidental data loss in Lasso, as certain items may not be included in the sync data.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventorySync'
      security:
      - JwtAuthorizer: []
      responses:
        200:
          description: Inventory updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryFull'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        409:
          $ref: '#/components/responses/ErrorInventoryAlreadySynced'
        500:
          $ref: '#/components/responses/InternalServerError'
  /inventory/{inventoryId}/reset:
    parameters:
    - in: path
      name: inventoryId
      schema:
        type: string
      required: true
      description: /inventory/123/reset
    post:
      tags:
      - Inventory
      summary: Reset an inventory items.
      operationId: post_inventory_reset
      security:
      - JwtAuthorizer: []
      responses:
        200:
          description: Inventory was successfully reset.
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    ErrorInventoryAlreadySynced:
      description: 'The inventory item you tried to create or sync with Lasso already exists

        or is already synced. Right now, it is only possible to sync an inventory

        item with Lasso once. Any subsequent changes will have to be applied

        manually (ie, adding a note)


        Alternatively, you can reset the inventory and sync again. Resetting

        the inventory will remove any associated information (ie, deposits,

        notes, etc). Any information that is not included in the sync will be

        lost. In addition, there may be issues with custom reports that inspect

        the system creation date of data (this is not related to dates included

        in the sync, like the deposit received date). If you choose to reset

        and sync the inventory, please ensure that you are not deleted data

        in Lasso.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardError'
    Unauthorized:
      description: The request has not been fulfilled because it lacks valid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardError'
    Forbidden:
      description: The provided authentication credentials does not have sufficient privileges to access this resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardError'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardError'
    ErrorInventoryCannotBeDeleted:
      description: The inventory you tried to delete was either "locked" or its status is not "Available"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardError'
    InternalServerError:
      description: Receiving a 5xx response indicates an error on Lasso's end. Please contact us to report the problem
    BadRequest:
      description: 'The request could not be processed due to invalid input:

        - Is the request payload malformed?

        - Are all required fields present?

        - Are field values of the expected type (ie, number format, date format)?

        - Are field values within the expected constraints (ie, greater than max size of string)?

        - Are query params of the expected format?


        Check the body model for more documentation on field constraints and limits.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StandardError'
  schemas:
    StorageLocker:
      title: Storage Locker
      properties:
        uniqueId:
          type: string
          example: '077'
        price:
          type: number
          example: '12000'
        date:
          type: string
          format: date
          example: '2017-08-30'
        paymentReceivedDate:
          type: string
          format: date
          example: '2017-08-30'
        outsideOfContract:
          type: boolean
          example: true
        description:
          type: string
          example: Part of storage package
    PricingRevision:
      title: PricingRevision
      type: object
      required:
      - name
      - amount
      properties:
        name:
          type: string
          example: Adapt to higher mortgage rates
        amount:
          type: number
          example: '-100000'
    Note:
      title: Note
      type: object
      required:
      - note
      properties:
        noteId:
          type: string
          example: '123'
        note:
          type: string
          example: Offered $10.000 credit
        createdAt:
          type: string
          description: Date in the ISO 8601 UTC format
          example: '2017-08-30T05:48:35Z'
    StandardError:
      type: object
      title: Standard Error
      description: A standard error response format.
      properties:
        errorCode:
          type: integer
          example: 4xx
        error:
          type: string
          description: A summary of the error
          example: A summary of the error
        errorMessage:
          type: string
          description: Details of the error
          example: Details of the error
    InventorySync:
      title: InventorySync
      properties:
        statusOverwrite:
          type: string
          description: Current status of inventory. Will default to existing value if not provided.
          enum:
          - Available
          - Unavailable
          - Reserved
          - Subject
          - Firm
          - Firm(R)
          - Offer
          - Closed
          example: Available
        plan:
          type: string
          example: E2
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        squareFootage:
          type: number
          example: 1251
          description: Will default to existing value if not provided.
        patioSquareFootage:
          type: number
          example: 70
          description: Will default to existing value if not provided.
        colorScheme:
          type: string
          example: Beige
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        maintenanceFee:
          type: number
          example: '351.12'
          description: Will default to existing value if not provided.
        floor:
          type: number
          example: 11
          description: Will default to existing value if not provided.
        bedrooms:
          type: string
          example: 2 Bedroom + Den
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        bathrooms:
          type: string
          example: 2 1/2
          description: Will default to existing value if not provided.
        direction:
          type: string
          example: SE
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        exposure:
          type: string
          example: South East
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        definition:
          type: string
          enum:
          - Unit
          - Townhome
          - Lot
          - Homesite
          example: Unit
          description: Will default to existing value if not provided.
        dates:
          $ref: '#/components/schemas/Dates'
        pricing:
          $ref: '#/components/schemas/Pricing'
        _links:
          type: object
          properties:
            self:
              type: string
              example: /inventory/123-123
            delete:
              type: string
              example: /inventory/123-123
        revisions:
          type: array
          items:
            $ref: '#/components/schemas/PricingRevision'
        notes:
          type: array
          items:
            $ref: '#/components/schemas/Note'
        subjects:
          type: array
          items:
            $ref: '#/components/schemas/Subject'
        deposits:
          type: array
          items:
            $ref: '#/components/schemas/Deposit'
        realtors:
          type: array
          description: Realtors associated with the inventory. Only a realtor's compensation may be updated, all non compensation fields will be ignored.
          items:
            $ref: '#/components/schemas/Realtor'
        bicycleLockers:
          type: array
          items:
            $ref: '#/components/schemas/BicycleLocker'
        storageLockers:
          type: array
          items:
            $ref: '#/components/schemas/StorageLocker'
        parkingStalls:
          type: array
          items:
            $ref: '#/components/schemas/ParkingStall'
        assignedSalesReps:
          type: array
          description: Assigned sales reps to this inventory
          items:
            $ref: '#/components/schemas/InventorySalesRep'
        salesReps:
          type: array
          items:
            type: string
            description: Name of sales rep. Deprecated, use `assignedSalesReps` instead
            example: John Smith
            deprecated: true
        purchasers:
          type: array
          description: List of registrant IDs to associate as purchasers with this inventory. Use the registrant create route to create a registrant if it does not exist yet.
          example:
          - 123
          - 456
          items:
            type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
    InventorySalesRep:
      type: object
      title: SalesRep Read Model
      description: Describes a sales rep.
      properties:
        firstName:
          type: string
          example: John
        lastName:
          type: string
          example: Doe
    InventoryCreate:
      title: InventoryCreate
      required:
      - strataLot
      - inventoryNumber
      properties:
        statusOverwrite:
          type: string
          description: Current status of inventory. Will default to existing value if not provided.
          enum:
          - Available
          - Unavailable
          - Reserved
          - Subject
          - Firm
          - Firm(R)
          - Offer
          - Closed
          example: Available
        plan:
          type: string
          example: E2
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        squareFootage:
          type: number
          example: 1251
          description: Will default to existing value if not provided.
        patioSquareFootage:
          type: number
          example: 70
          description: Will default to existing value if not provided.
        colorScheme:
          type: string
          example: Beige
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        maintenanceFee:
          type: number
          example: '351.12'
          description: Will default to existing value if not provided.
        floor:
          type: number
          example: 11
          description: Will default to existing value if not provided.
        bedrooms:
          type: string
          example: 2 Bedroom + Den
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        bathrooms:
          type: string
          example: 2 1/2
          description: Will default to existing value if not provided.
        direction:
          type: string
          example: SE
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        exposure:
          type: string
          example: South East
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        definition:
          type: string
          enum:
          - Unit
          - Townhome
          - Lot
          - Homesite
          example: Unit
          description: Will default to existing value if not provided.
        dates:
          $ref: '#/components/schemas/Dates'
        pricing:
          $ref: '#/components/schemas/Pricing'
        _links:
          type: object
          properties:
            self:
              type: string
              example: /inventory/123-123
            delete:
              type: string
              example: /inventory/123-123
        component:
          $ref: '#/components/schemas/Component'
        strataLot:
          type: string
          example: 123
        inventoryNumber:
          type: string
          example: 123
    InventoryRead:
      title: InventoryRead
      properties:
        statusOverwrite:
          type: string
          description: Current status of inventory. Will default to existing value if not provided.
          enum:
          - Available
          - Unavailable
          - Reserved
          - Subject
          - Firm
          - Firm(R)
          - Offer
          - Closed
          example: Available
        plan:
          type: string
          example: E2
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        squareFootage:
          type: number
          example: 1251
          description: Will default to existing value if not provided.
        patioSquareFootage:
          type: number
          example: 70
          description: Will default to existing value if not provided.
        colorScheme:
          type: string
          example: Beige
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        maintenanceFee:
          type: number
          example: '351.12'
          description: Will default to existing value if not provided.
        floor:
          type: number
          example: 11
          description: Will default to existing value if not provided.
        bedrooms:
          type: string
          example: 2 Bedroom + Den
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        bathrooms:
          type: string
          example: 2 1/2
          description: Will default to existing value if not provided.
        direction:
          type: string
          example: SE
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        exposure:
          type: string
          example: South East
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        definition:
          type: string
          enum:
          - Unit
          - Townhome
          - Lot
          - Homesite
          example: Unit
          description: Will default to existing value if not provided.
        dates:
          $ref: '#/components/schemas/Dates'
        pricing:
          $ref: '#/components/schemas/Pricing'
        _links:
          type: object
          properties:
            self:
              type: string
              example: /inventory/123-123
            delete:
              type: string
              example: /inventory/123-123
        inventoryId:
          type: string
          description: Lasso-internal inventory ID
          example: 123
        component:
          $ref: '#/components/schemas/Component'
        project:
          $ref: '#/components/schemas/Project'
        strataLot:
          type: string
          example: 123
        inventoryNumber:
          type: string
          example: 123
    InventoryFull:
      title: InventoryFull
      properties:
        statusOverwrite:
          type: string
          description: Current status of inventory. Will default to existing value if not provided.
          enum:
          - Available
          - Unavailable
          - Reserved
          - Subject
          - Firm
          - Firm(R)
          - Offer
          - Closed
          example: Available
        plan:
          type: string
          example: E2
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        squareFootage:
          type: number
          example: 1251
          description: Will default to existing value if not provided.
        patioSquareFootage:
          type: number
          example: 70
          description: Will default to existing value if not provided.
        colorScheme:
          type: string
          example: Beige
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        maintenanceFee:
          type: number
          example: '351.12'
          description: Will default to existing value if not provided.
        floor:
          type: number
          example: 11
          description: Will default to existing value if not provided.
        bedrooms:
          type: string
          example: 2 Bedroom + Den
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        bathrooms:
          type: string
          example: 2 1/2
          description: Will default to existing value if not provided.
        direction:
          type: string
          example: SE
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        exposure:
          type: string
          example: South East
          description: This field has to be set up in Lasso. It is matched to an existing option via the name. If no existing option is found, a new one is created. Will default to existing value if not provided.
        definition:
          type: string
          enum:
          - Unit
          - Townhome
          - Lot
          - Homesite
          example: Unit
          description: Will default to existing value if not provided.
        dates:
          $ref: '#/components/schemas/Dates'
        pricing:
          $ref: '#/components/schemas/Pricing'
        _links:
          type: object
          properties:
            self:
              type: string
              example: /inventory/123-123
            delete:
              type: string
              example: /inventory/123-123
        inventoryId:
          type: string
          description: Lasso-internal inventory ID
          example: 123
        component:
          $ref: '#/components/schemas/Component'
        project:
          $ref: '#/components/schemas/Project'
        strataLot:
          type: string
          example: 123
        inventoryNumber:
          type: string
          example: 123
        revisions:
          type: array
          items:
            $ref: '#/components/schemas/PricingRevision'
        notes:
          type: array
          items:
            $ref: '#/components/schemas/Note'
        subjects:
          type: array
          items:
            $ref: '#/components/schemas/Subject'
        deposits:
          type: array
          items:
            $ref: '#/components/schemas/Deposit'
        realtors:
          type: array
          items:
            $ref: '#/components/schemas/Realtor'
        bicycleLockers:
          type: array
          items:
            $ref: '#/components/schemas/BicycleLocker'
        storageLockers:
          type: array
          items:
            $ref: '#/components/schemas/StorageLocker'
        parkingStalls:
          type: array
          items:
            $ref: '#/components/schemas/ParkingStall'
        assignedSalesReps:
          type: array
          description: Assigned sales reps to this inventory
          items:
            $ref: '#/components/schemas/InventorySalesRep'
        salesReps:
          type: array
          items:
            type: string
            description: Name of sales rep. Deprecated, use `assignedSalesReps` instead
            example: John Smith
            deprecated: true
        purchasers:
          type: array
          description: List of registrant IDs to associate as purchasers with this inventory. Use the registrant create route to create a registrant if it does not exist yet.
          example:
          - 123
          - 456
          items:
            type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
    Subject:
      type: object
      required:
      - purchaser
      - subjectDate
      - description
      properties:
        purchaser:
          type: string
          example: '123'
          description: RegistrantId of a registrant assigned to the inventory
        subjectDate:
          type: string
          format: date
          example: '2017-08-14'
        description:
          type: string
          example: Adjust doors that do not close properly
        removed:
          type: boolean
          example: false
        removalDate:
          type: string
          format: date
          example: '2017-08-25'
        removalDescription:
          type: string
          example: Contractor sanded doors, all close properly now
    Project:
      title: Project
      type: object
      properties:
        name:
          type: string
          example: Birch Towers
        projectId:
          type: string
          example: 123
    Pricing:
      title: Pricing
      type: object
      description: Sets the pricing information for the inventory in Lasso. Setting all fields to 0 except the `initialPrice` allows you to specify an exact sales price.
      required:
      - initialPrice
      properties:
        initialPrice:
          type: number
          description: Base price of inventory
          example: '4300000'
        adjustedGrossPrice:
          type: number
          example: '-50000'
        offTheTopDiscount:
          type: number
          example: '-10000'
        inLieuOfIncentive:
          type: number
          example: '10000'
        credit:
          type: number
          example: '25000'
        _links:
          type: object
          properties:
            self:
              type: string
              example: /inventory/123-123/pricing
            update:
              type: string
              example: /inventory/123-123/pricing
    Dates:
      title: Dates
      type: object
      description: All dates are in the ISO 8601 UTC format, limited to year, month and day (YYYY-MM-DD). Will set all dates to blank if not provided.
      properties:
        contract:
          type: string
          format: date
          example: '2017-08-05'
        acceptance:
          type: string
          format: date
          example: '2017-08-08'
        completion:
          type: string
          format: date
          example: '2017-08-11'
        release:
          type: string
          format: date
          example: '2017-08-08'
        possession:
          type: string
          format: date
          example: '2017-08-15'
        occupancy:
          type: string
          format: date
          example: '2017-08-19'
        sendToLawyer:
          type: string
          format: date
          example: '2017-08-12'
        adjustment:
          type: string
          format: date
          example: '2017-08-30'
        _links:
          type: object
          properties:
            self:
              type: string
              example: /inventory/123-123/dates
            u

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/openapi/eci-solutions-inventory-api-openapi.yml